Claude Platform Docs

組織

現在の組織を取得
BetaOrganization Beta.Organization.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/me

認証済みのAPIキーに関連付けられた組織の情報を取得します。

Models
class BetaOrganization { Type = "organization"; ID; Name; }
JsonElement Type = "organization"

Object type.

For Organizations, this is always "organization".

required string ID

ID of the Organization.

formatuuid
required string Name

Name of the Organization.

enum BetaOrganizationRole
Admin("admin")
Billing("billing")
ClaudeCodeUser("claude_code_user")
Developer("developer")
Managed("managed")
MembershipAdmin("membership_admin")
Owner("owner")
PrimaryOwner("primary_owner")
User("user")

組織APIキー

APIキーの一覧を取得
ApiKeyListPage Beta.Organization.ApiKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
APIキーを取得（Admin API）
BetaApiKey Beta.Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/api_keys/{api_key_id}

組織内の単一のAPIキーに関する情報を、IDを指定して取得します。このAdmin APIエンドポイントにはAdmin APIキーが必要で、プログラムによるキー管理を目的としており、キーのシークレット値を返すことはありません。自分のAPIキーを表示または作成するには、Claude ConsoleのAPIキーにアクセスしてください。

APIキーを更新
BetaApiKey Beta.Organization.ApiKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}

組織外部キー

外部キーを作成
BetaExternalKey Beta.Organization.ExternalKeys.Create(parameters, cancellationToken = default)
POST/v1/organizations/external_keys

呼び出し元の組織が所有する外部キー設定を作成します。

外部キーの一覧を取得
ExternalKeyListPage Beta.Organization.ExternalKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/external_keys

呼び出し元の組織内の外部キー設定を一覧表示します。

外部キーを取得
BetaExternalKey Beta.Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/external_keys/{external_key_id}

呼び出し元の組織内の単一の外部キー設定を、IDを指定して取得します。

外部キーを更新
BetaExternalKey Beta.Organization.ExternalKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}

外部キー設定を部分的に更新します。省略されたフィールドは変更されません。

外部キーを削除
ExternalKeyDeleteResponse Beta.Organization.ExternalKeys.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/external_keys/{external_key_id}

外部キー設定を削除します。

外部キーを検証
ExternalKeyValidateResponse Beta.Organization.ExternalKeys.Validate(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}/validate

外部キー設定を顧客の KMS に対して検証します。

組織フェデレーション発行者

フェデレーション発行者を作成
BetaFederationIssuer Beta.Organization.Federation.Issuers.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーション発行者の一覧を取得
IssuerListPage Beta.Organization.Federation.Issuers.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーション発行者を取得
BetaFederationIssuer Beta.Organization.Federation.Issuers.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers/{federation_issuer_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーション発行者を更新
BetaFederationIssuer Beta.Organization.Federation.Issuers.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーション発行者をアーカイブ
BetaFederationIssuer Beta.Organization.Federation.Issuers.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

組織フェデレーションルール

フェデレーションルールを作成
BetaFederationRule Beta.Organization.Federation.Rules.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールの一覧を取得
RuleListPage Beta.Organization.Federation.Rules.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールを取得
BetaFederationRule Beta.Organization.Federation.Rules.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールを更新
BetaFederationRule Beta.Organization.Federation.Rules.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールをアーカイブ
BetaFederationRule Beta.Organization.Federation.Rules.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

組織フェデレーションルールワークスペース

フェデレーションルールのワークスペースを追加
BetaFederationRuleWorkspace Beta.Organization.Federation.Rules.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールのワークスペースの一覧を取得
WorkspaceListPage Beta.Organization.Federation.Rules.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

フェデレーションルールのワークスペースを削除
WorkspaceRemoveResponse Beta.Organization.Federation.Rules.Workspaces.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

組織招待

招待を作成
BetaOrganizationInvite Beta.Organization.Invites.Create(parameters, cancellationToken = default)
POST/v1/organizations/invites

メールでユーザーを組織に招待します。

招待の一覧を取得
InviteListPage Beta.Organization.Invites.List(parameters, cancellationToken = default)
GET/v1/organizations/invites

組織の招待を一覧表示します。

招待を取得
BetaOrganizationInvite Beta.Organization.Invites.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/invites/{invite_id}

ID で招待を取得します。

招待を削除
InviteDeleteResponse Beta.Organization.Invites.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/invites/{invite_id}

保留中の招待を削除します。

組織サービスアカウント

サービスアカウントを作成
BetaServiceAccount Beta.Organization.ServiceAccounts.Create(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントの一覧を取得
ServiceAccountListPage Beta.Organization.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントを取得
BetaServiceAccount Beta.Organization.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントを更新
BetaServiceAccount Beta.Organization.ServiceAccounts.Update(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントをアーカイブ
BetaServiceAccount Beta.Organization.ServiceAccounts.Archive(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/archive

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

組織サービスアカウントワークスペース

サービスアカウントにワークスペースを追加
BetaServiceAccountWorkspaceMember Beta.Organization.ServiceAccounts.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースの一覧を取得
WorkspaceListPage Beta.Organization.ServiceAccounts.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントからワークスペースを削除
WorkspaceRemoveResponse Beta.Organization.ServiceAccounts.Workspaces.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

組織ユーザー

ユーザーの一覧を取得
UserListPage Beta.Organization.Users.List(parameters, cancellationToken = default)
GET/v1/organizations/users

組織のメンバーを一覧表示します。

ユーザーを取得
BetaOrganizationUser Beta.Organization.Users.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/users/{user_id}

ユーザー ID で組織のメンバーを取得します。

ユーザーを更新
BetaOrganizationUser Beta.Organization.Users.Update(parameters, cancellationToken = default)
POST/v1/organizations/users/{user_id}

メンバーの組織ロールを更新します。

ユーザーを削除
UserRemoveResponse Beta.Organization.Users.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/users/{user_id}

組織からメンバーを削除します。

組織ワークスペース

ワークスペースの一覧を取得
WorkspaceListPage Beta.Organization.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces
ワークスペースを作成
BetaWorkspace Beta.Organization.Workspaces.Create(parameters, cancellationToken = default)
POST/v1/organizations/workspaces
ワークスペースを取得
BetaWorkspace Beta.Organization.Workspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}
ワークスペースを更新
BetaWorkspace Beta.Organization.Workspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}
ワークスペースをアーカイブ
BetaWorkspace Beta.Organization.Workspaces.Archive(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/archive

組織ワークスペースレート制限

ワークスペースのレート制限の一覧を取得
RateLimitListPage Beta.Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

ワークスペースに設定されたレート制限のオーバーライドを一覧表示します。

組織ワークスペースメンバー

ワークスペースメンバーの一覧を取得
MemberListPage Beta.Organization.Workspaces.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members
ワークスペースメンバーを作成
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members
ワークスペースメンバーを取得
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
ワークスペースメンバーを更新
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
ワークスペースメンバーを削除
MemberRemoveResponse Beta.Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

組織ワークスペースサービスアカウント

サービスアカウントのワークスペースメンバーの一覧を取得
ServiceAccountListPage Beta.Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを作成
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを取得
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを更新
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを削除
ServiceAccountRemoveResponse Beta.Organization.Workspaces.ServiceAccounts.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

組織レート制限

組織のレート制限の一覧を取得
RateLimitListPage Beta.Organization.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/rate_limits

組織の Messages API のレート制限（rate limit）を一覧表示します。

組織コンプライアンス設定

コンプライアンス設定を取得
BetaComplianceSettings Beta.Organization.ComplianceSettings.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/compliance_settings

組織のコンプライアンス設定を取得します。

コンプライアンス設定を更新
BetaComplianceSettings Beta.Organization.ComplianceSettings.Update(parameters, cancellationToken = default)
POST/v1/organizations/compliance_settings

組織のコンプライアンス設定を更新します。