Claude Platform Docs

組織

現在の組織を取得
client.organization.retrieve(options?): OrganizationInfo
GET/v1/organizations/me

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

Models
interface OrganizationInfo { type: "organization"; id; name }
type: "organization"

Object type.

For Organizations, this is always "organization".

defaultorganization
id: string

ID of the Organization.

formatuuid
name: string

Name of the Organization.

type OrganizationRole = "admin" | "billing" | "claude_code_user" | 6 more
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

組織APIキー

APIキー一覧を取得
client.organization.apiKeys.list(query?, options?): Page<APIKey>
GET/v1/organizations/api_keys
APIキーを取得（Admin API）
client.organization.apiKeys.retrieve(apiKeyID, options?): APIKey
GET/v1/organizations/api_keys/{api_key_id}

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

APIキーを更新
client.organization.apiKeys.update(apiKeyID, body, options?): APIKey
POST/v1/organizations/api_keys/{api_key_id}

組織外部キー

外部キーを作成
client.organization.externalKeys.create(body, options?): ExternalKey
POST/v1/organizations/external_keys

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

外部キー一覧を取得
client.organization.externalKeys.list(query?, options?): PageCursor<ExternalKey>
GET/v1/organizations/external_keys

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

外部キーを取得
client.organization.externalKeys.retrieve(externalKeyID, options?): ExternalKey
GET/v1/organizations/external_keys/{external_key_id}

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

外部キーを更新
client.organization.externalKeys.update(externalKeyID, body, options?): ExternalKey
POST/v1/organizations/external_keys/{external_key_id}

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

外部キーを削除
client.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

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

外部キーを検証
client.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

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

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

フェデレーション発行者を作成
client.organization.federation.issuers.create(body, options?): FederationIssuer
POST/v1/organizations/federation_issuers

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

フェデレーション発行者一覧を取得
client.organization.federation.issuers.list(query?, options?): PageCursor<FederationIssuer>
GET/v1/organizations/federation_issuers

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

フェデレーション発行者を取得
client.organization.federation.issuers.retrieve(federationIssuerID, options?): FederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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

フェデレーション発行者を更新
client.organization.federation.issuers.update(federationIssuerID, body, options?): FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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

フェデレーション発行者をアーカイブ
client.organization.federation.issuers.archive(federationIssuerID, options?): FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

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

フェデレーションルールを作成
client.organization.federation.rules.create(body, options?): FederationRule
POST/v1/organizations/federation_rules

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

フェデレーションルール一覧を取得
client.organization.federation.rules.list(query?, options?): PageCursor<FederationRule>
GET/v1/organizations/federation_rules

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

フェデレーションルールを取得
client.organization.federation.rules.retrieve(federationRuleID, options?): FederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}

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

フェデレーションルールを更新
client.organization.federation.rules.update(federationRuleID, body, options?): FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}

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

フェデレーションルールをアーカイブ
client.organization.federation.rules.archive(federationRuleID, options?): FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

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

フェデレーションルールのワークスペースを追加
client.organization.federation.rules.workspaces.add(federationRuleID, body, options?): FederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

フェデレーションルールのワークスペース一覧を取得
client.organization.federation.rules.workspaces.list(federationRuleID, query?, options?): PageCursor<FederationRuleWorkspace>
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

フェデレーションルールのワークスペースを削除
client.organization.federation.rules.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

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

組織招待

招待を作成
client.organization.invites.create(body, options?): OrganizationInvite
POST/v1/organizations/invites

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

招待一覧を取得
client.organization.invites.list(query?, options?): Page<OrganizationInvite>
GET/v1/organizations/invites

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

招待を取得
client.organization.invites.retrieve(inviteID, options?): OrganizationInvite
GET/v1/organizations/invites/{invite_id}

IDで招待を取得します。

招待を削除
client.organization.invites.delete(inviteID, options?): InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

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

組織サービスアカウント

サービスアカウントを作成
client.organization.serviceAccounts.create(body, options?): ServiceAccount
POST/v1/organizations/service_accounts

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

サービスアカウント一覧を取得
client.organization.serviceAccounts.list(query?, options?): PageCursor<ServiceAccount>
GET/v1/organizations/service_accounts

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

サービスアカウントを取得
client.organization.serviceAccounts.retrieve(serviceAccountID, options?): ServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}

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

サービスアカウントを更新
client.organization.serviceAccounts.update(serviceAccountID, body, options?): ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}

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

サービスアカウントをアーカイブ
client.organization.serviceAccounts.archive(serviceAccountID, options?): ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

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

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

サービスアカウントにワークスペースを追加
client.organization.serviceAccounts.workspaces.add(serviceAccountID, body, options?): ServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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

サービスアカウントのワークスペース一覧を取得
client.organization.serviceAccounts.workspaces.list(serviceAccountID, query?, options?): PageCursor<ServiceAccountWorkspaceMember>
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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

サービスアカウントからワークスペースを削除
client.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

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

組織ユーザー

ユーザー一覧を取得
client.organization.users.list(query?, options?): Page<OrganizationUser>
GET/v1/organizations/users

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

ユーザーを取得
client.organization.users.retrieve(userID, options?): OrganizationUser
GET/v1/organizations/users/{user_id}

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

ユーザーを更新
client.organization.users.update(userID, body, options?): OrganizationUser
POST/v1/organizations/users/{user_id}

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

ユーザーを削除
client.organization.users.remove(userID, options?): UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

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

組織ワークスペース

ワークスペース一覧を取得
client.organization.workspaces.list(query?, options?): Page<Workspace>
GET/v1/organizations/workspaces
ワークスペースを作成
client.organization.workspaces.create(body, options?): Workspace
POST/v1/organizations/workspaces
ワークスペースを取得
client.organization.workspaces.retrieve(workspaceID, options?): Workspace
GET/v1/organizations/workspaces/{workspace_id}
ワークスペースを更新
client.organization.workspaces.update(workspaceID, body, options?): Workspace
POST/v1/organizations/workspaces/{workspace_id}
ワークスペースをアーカイブ
client.organization.workspaces.archive(workspaceID, options?): Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

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

ワークスペースのレート制限一覧を取得
client.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<WorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

ワークスペースのレート制限を一覧表示します。

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

ワークスペースメンバー一覧を取得
client.organization.workspaces.members.list(workspaceID, query?, options?): Page<WorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
ワークスペースメンバーを作成
client.organization.workspaces.members.add(workspaceID, body, options?): WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
ワークスペースメンバーを取得
client.organization.workspaces.members.retrieve(userID, params, options?): WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
ワークスペースメンバーを更新
client.organization.workspaces.members.update(userID, params, options?): WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
ワークスペースメンバーを削除
client.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

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

サービスアカウントのワークスペースメンバー一覧を取得
client.organization.workspaces.serviceAccounts.list(workspaceID, query?, options?): PageCursor<ServiceAccountWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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

サービスアカウントのワークスペースメンバーを作成
client.organization.workspaces.serviceAccounts.add(workspaceID, body, options?): ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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

サービスアカウントのワークスペースメンバーを取得
client.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): ServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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

サービスアカウントのワークスペースメンバーを更新
client.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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

サービスアカウントのワークスペースメンバーを削除
client.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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

組織レート制限

組織のレート制限を一覧表示
client.organization.rateLimits.list(query?, options?): PageCursor<OrganizationRateLimit>
GET/v1/organizations/rate_limits

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

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

コンプライアンス設定を取得
client.organization.complianceSettings.retrieve(options?): OrganizationComplianceSettings
GET/v1/organizations/compliance_settings

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

コンプライアンス設定を更新
client.organization.complianceSettings.update(body, options?): OrganizationComplianceSettings
POST/v1/organizations/compliance_settings

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