Claude Platform Docs

組織

現在の組織を取得
$client->beta->organization->retrieve(): BetaOrganization
GET/v1/organizations/me

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

Models
class BetaOrganization { $type = 'organization'; $id; $name; }
"organization" type

Object type.

For Organizations, this is always "organization".

string id

ID of the Organization.

string name

Name of the Organization.

enum BetaOrganizationRole
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

組織APIキー

APIキーの一覧を取得
$client->beta->organization->apiKeys->list(?string afterID, ?string beforeID, ?string createdByUserID, ?int limit, ?Status status, ?string workspaceID): Page<APIKey>
GET/v1/organizations/api_keys
APIキーを取得（Admin API）
$client->beta->organization->apiKeys->retrieve(string apiKeyID): APIKey
GET/v1/organizations/api_keys/{api_key_id}

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

APIキーを更新
$client->beta->organization->apiKeys->update(string apiKeyID, ?string name, ?Status status): APIKey
POST/v1/organizations/api_keys/{api_key_id}

組織外部キー

外部キーを作成
$client->beta->organization->externalKeys->create(ProviderConfig providerConfig, ?string displayName, ?Geo geo): ExternalKey
POST/v1/organizations/external_keys

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

外部キーの一覧を取得
$client->beta->organization->externalKeys->list(?int limit, ?string page): PageCursor<ExternalKey>
GET/v1/organizations/external_keys

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

外部キーを取得
$client->beta->organization->externalKeys->retrieve(string externalKeyID): ExternalKey
GET/v1/organizations/external_keys/{external_key_id}

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

外部キーを更新
$client->beta->organization->externalKeys->update(string externalKeyID, ?string displayName, ?Geo geo, ?ProviderConfig providerConfig): ExternalKey
POST/v1/organizations/external_keys/{external_key_id}

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

外部キーを削除
$client->beta->organization->externalKeys->delete(string externalKeyID): ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

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

外部キーを検証
$client->beta->organization->externalKeys->validate(string externalKeyID): ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

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

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

フェデレーション発行者を作成
$client->beta->organization->federation->issuers->create(string issuerURL, string name, ?bool checkJTI, ?JWKS jwks, ?int maxJWTLifetimeSeconds, ?list<AnthropicBeta> betas): BetaFederationIssuer
POST/v1/organizations/federation_issuers

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

フェデレーション発行者の一覧を取得
$client->beta->organization->federation->issuers->list(?bool includeArchived, ?int limit, ?string page, ?list<AnthropicBeta> betas): PageCursor<BetaFederationIssuer>
GET/v1/organizations/federation_issuers

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

フェデレーション発行者を取得
$client->beta->organization->federation->issuers->retrieve(string federationIssuerID, ?list<AnthropicBeta> betas): BetaFederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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

フェデレーション発行者を更新
$client->beta->organization->federation->issuers->update(string federationIssuerID, ?bool checkJTI, ?string issuerURL, ?JWKS jwks, ?bool jwksPollingDisabled, ?int maxJWTLifetimeSeconds, ?string name, ?list<AnthropicBeta> betas): BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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

フェデレーション発行者をアーカイブ
$client->beta->organization->federation->issuers->archive(string federationIssuerID, ?list<AnthropicBeta> betas): BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

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

フェデレーションルールを作成
$client->beta->organization->federation->rules->create(string issuerID, BetaFederationRuleMatch match, string name, string oauthScope, BetaServiceAccountTarget target, ?bool appliesToAllWorkspaces, ?array<string,string> attributes, ?string description, ?int tokenLifetimeSeconds, ?string workspaceID, ?list<AnthropicBeta> betas): BetaFederationRule
POST/v1/organizations/federation_rules

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

フェデレーションルールの一覧を取得
$client->beta->organization->federation->rules->list(?bool includeArchived, ?string issuerID, ?int limit, ?string page, ?list<AnthropicBeta> betas): PageCursor<BetaFederationRule>
GET/v1/organizations/federation_rules

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

フェデレーションルールを取得
$client->beta->organization->federation->rules->retrieve(string federationRuleID, ?list<AnthropicBeta> betas): BetaFederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}

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

フェデレーションルールを更新
$client->beta->organization->federation->rules->update(string federationRuleID, ?bool appliesToAllWorkspaces, ?array<string,string> attributes, ?string description, ?BetaFederationRuleMatch match, ?string name, ?string oauthScope, ?BetaServiceAccountTarget target, ?int tokenLifetimeSeconds, ?string workspaceID, ?list<AnthropicBeta> betas): BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}

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

フェデレーションルールをアーカイブ
$client->beta->organization->federation->rules->archive(string federationRuleID, ?list<AnthropicBeta> betas): BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

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

フェデレーションルールのワークスペースを追加
$client->beta->organization->federation->rules->workspaces->add(string federationRuleID, string workspaceID, ?list<AnthropicBeta> betas): BetaFederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

フェデレーションルールのワークスペースの一覧を取得
$client->beta->organization->federation->rules->workspaces->list(string federationRuleID, ?int limit, ?string page, ?list<AnthropicBeta> betas): PageCursor<BetaFederationRuleWorkspace>
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

フェデレーションルールのワークスペースを削除
$client->beta->organization->federation->rules->workspaces->remove(string workspaceID, string federationRuleID, ?list<AnthropicBeta> betas): WorkspaceRemoveResponse
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 を管理するを参照してください。

組織招待

招待を作成
$client->beta->organization->invites->create(string email, Role role, ?list<string> rbacGroupIDs): OrganizationInvite
POST/v1/organizations/invites

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

招待の一覧を取得
$client->beta->organization->invites->list(?string afterID, ?string beforeID, ?string email, ?int limit, ?list<string> roles, ?list<Status> statuses): Page<OrganizationInvite>
GET/v1/organizations/invites

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

招待を取得
$client->beta->organization->invites->retrieve(string inviteID): OrganizationInvite
GET/v1/organizations/invites/{invite_id}

ID で招待を取得します。

招待を削除
$client->beta->organization->invites->delete(string inviteID): InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

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

組織サービスアカウント

サービスアカウントを作成
$client->beta->organization->serviceAccounts->create(string name, ?string description, ?OrganizationRole organizationRole, ?list<AnthropicBeta> betas): ServiceAccount
POST/v1/organizations/service_accounts

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

サービスアカウントの一覧を取得
$client->beta->organization->serviceAccounts->list(?bool includeArchived, ?int limit, ?string page, ?list<AnthropicBeta> betas): PageCursor<ServiceAccount>
GET/v1/organizations/service_accounts

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

サービスアカウントを取得
$client->beta->organization->serviceAccounts->retrieve(string serviceAccountID, ?list<AnthropicBeta> betas): ServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}

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

サービスアカウントを更新
$client->beta->organization->serviceAccounts->update(string serviceAccountID, ?string description, ?OrganizationRole organizationRole, ?list<AnthropicBeta> betas): ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}

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

サービスアカウントをアーカイブ
$client->beta->organization->serviceAccounts->archive(string serviceAccountID, ?list<AnthropicBeta> betas): ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

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

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

サービスアカウントにワークスペースを追加
$client->beta->organization->serviceAccounts->workspaces->add(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole, ?list<AnthropicBeta> betas): ServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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

サービスアカウントのワークスペースの一覧を取得
$client->beta->organization->serviceAccounts->workspaces->list(string serviceAccountID, ?int limit, ?string page, ?list<AnthropicBeta> betas): PageCursor<ServiceAccountWorkspaceMember>
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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

サービスアカウントからワークスペースを削除
$client->beta->organization->serviceAccounts->workspaces->remove(string workspaceID, string serviceAccountID, ?list<AnthropicBeta> betas): WorkspaceRemoveResponse
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 を管理するを参照してください。

組織ユーザー

ユーザーの一覧を取得
$client->beta->organization->users->list(?string afterID, ?string beforeID, ?string email, ?int limit, ?list<string> roles): Page<OrganizationUser>
GET/v1/organizations/users

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

ユーザーを取得
$client->beta->organization->users->retrieve(string userID): OrganizationUser
GET/v1/organizations/users/{user_id}

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

ユーザーを更新
$client->beta->organization->users->update(string userID, Role role): OrganizationUser
POST/v1/organizations/users/{user_id}

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

ユーザーを削除
$client->beta->organization->users->remove(string userID): UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

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

組織ワークスペース

ワークスペースの一覧を取得
$client->beta->organization->workspaces->list(?string afterID, ?string beforeID, ?bool includeArchived, ?int limit): Page<Workspace>
GET/v1/organizations/workspaces
ワークスペースを作成
$client->beta->organization->workspaces->create(string name, ?DataResidencyCreateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?array<string,string> tags, ?list<AnthropicBeta> betas): Workspace
POST/v1/organizations/workspaces
ワークスペースを取得
$client->beta->organization->workspaces->retrieve(string workspaceID): Workspace
GET/v1/organizations/workspaces/{workspace_id}
ワークスペースを更新
$client->beta->organization->workspaces->update(string workspaceID, ?DataResidencyUpdateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?string name, ?array<string,string> tags): Workspace
POST/v1/organizations/workspaces/{workspace_id}
ワークスペースをアーカイブ
$client->beta->organization->workspaces->archive(string workspaceID): Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

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

ワークスペースのレート制限の一覧を取得
$client->beta->organization->workspaces->rateLimits->list(string workspaceID, ?GroupType groupType, ?int limit, ?string page): PageCursor<BetaWorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

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

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

ワークスペースメンバーの一覧を取得
$client->beta->organization->workspaces->members->list(string workspaceID, ?string afterID, ?string beforeID, ?int limit): Page<WorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
ワークスペースメンバーを作成
$client->beta->organization->workspaces->members->add(string workspaceID, string userID, NoBillingWorkspaceRole workspaceRole): WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
ワークスペースメンバーを取得
$client->beta->organization->workspaces->members->retrieve(string userID, string workspaceID): WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
ワークスペースメンバーを更新
$client->beta->organization->workspaces->members->update(string userID, string workspaceID, WorkspaceRole workspaceRole): WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
ワークスペースメンバーを削除
$client->beta->organization->workspaces->members->remove(string userID, string workspaceID): MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

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

サービスアカウントのワークスペースメンバーの一覧を取得
$client->beta->organization->workspaces->serviceAccounts->list(string workspaceID, ?int limit, ?string page, ?list<AnthropicBeta> betas): PageCursor<ServiceAccountWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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

サービスアカウントのワークスペースメンバーを作成
$client->beta->organization->workspaces->serviceAccounts->add(string workspaceID, string serviceAccountID, NoBillingWorkspaceRole workspaceRole, ?list<AnthropicBeta> betas): ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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

サービスアカウントのワークスペースメンバーを取得
$client->beta->organization->workspaces->serviceAccounts->retrieve(string serviceAccountID, string workspaceID, ?list<AnthropicBeta> betas): ServiceAccountWorkspaceMember
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 を管理するを参照してください。

サービスアカウントのワークスペースメンバーを更新
$client->beta->organization->workspaces->serviceAccounts->update(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole, ?list<AnthropicBeta> betas): ServiceAccountWorkspaceMember
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 を管理するを参照してください。

サービスアカウントのワークスペースメンバーを削除
$client->beta->organization->workspaces->serviceAccounts->remove(string serviceAccountID, string workspaceID, ?list<AnthropicBeta> betas): ServiceAccountRemoveResponse
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 を管理するを参照してください。

組織レート制限

組織のレート制限の一覧を取得
$client->beta->organization->rateLimits->list(?GroupType groupType, ?int limit, ?string model, ?string page): PageCursor<OrganizationRateLimit>
GET/v1/organizations/rate_limits

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

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

コンプライアンス設定を取得
$client->beta->organization->complianceSettings->retrieve(): ComplianceSettings
GET/v1/organizations/compliance_settings

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

コンプライアンス設定を更新
$client->beta->organization->complianceSettings->update(ComplianceSettingsStateParam state): ComplianceSettings
POST/v1/organizations/compliance_settings

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