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}

按 ID 检索您组织中单个 API 密钥的信息。此 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

列出工作区的速率限制（rate limit）。

组织工作区成员

列出工作区成员
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 或 "workload identity federation"（工作负载身份联合）规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

组织速率限制

列出组织速率限制
client.organization.rateLimits.list(query?, options?): PageCursor<OrganizationRateLimit>
GET/v1/organizations/rate_limits

列出您组织的 Messages API "rate limit"（速率限制）。

组织合规设置

获取合规设置
client.organization.complianceSettings.retrieve(options?): OrganizationComplianceSettings
GET/v1/organizations/compliance_settings

检索您组织的合规设置。

更新合规设置
client.organization.complianceSettings.update(body, options?): OrganizationComplianceSettings
POST/v1/organizations/compliance_settings

更新您组织的合规设置。