Claude Platform Docs

组织

获取当前组织
organization.retrieve() -> OrganizationInfo
GET/v1/organizations/me

检索与经过身份验证的 API 密钥关联的组织的信息。

Models
class OrganizationInfo: type: "organization"; id; name
type: Literal["organization"]

Object type.

For Organizations, this is always "organization".

defaultorganization
id: str

ID of the Organization.

formatuuid
name: str

Name of the Organization.

type OrganizationRole = Literal["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 密钥
organization.api_keys.list(**kwargs) -> SyncPage[APIKey]
GET/v1/organizations/api_keys
检索 API 密钥（Admin API）
organization.api_keys.retrieve(api_key_id) -> APIKey
GET/v1/organizations/api_keys/{api_key_id}

按 ID 检索您组织中单个 API 密钥的信息。此 Admin API 端点需要 Admin API 密钥，用于以编程方式管理密钥，并且绝不会返回密钥的机密值。要查看或创建您自己的 API 密钥，请前往 Claude Console 中的 API 密钥页面。

更新 API 密钥
organization.api_keys.update(api_key_id, **kwargs) -> APIKey
POST/v1/organizations/api_keys/{api_key_id}

组织外部密钥

创建外部密钥
organization.external_keys.create(**kwargs) -> ExternalKey
POST/v1/organizations/external_keys

创建一个归调用方组织所有的外部密钥配置。

列出外部密钥
organization.external_keys.list(**kwargs) -> SyncPageCursor[ExternalKey]
GET/v1/organizations/external_keys

列出调用方组织中的外部密钥配置。

获取外部密钥
organization.external_keys.retrieve(external_key_id) -> ExternalKey
GET/v1/organizations/external_keys/{external_key_id}

按 ID 检索调用方组织中的单个外部密钥配置。

更新外部密钥
organization.external_keys.update(external_key_id, **kwargs) -> ExternalKey
POST/v1/organizations/external_keys/{external_key_id}

部分更新外部密钥配置。省略的字段保持不变。

删除外部密钥
organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

删除外部密钥配置。

验证外部密钥
organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

针对客户的 KMS 验证外部密钥配置。

组织联合颁发者

创建联合颁发者
organization.federation.issuers.create(**kwargs) -> FederationIssuer
POST/v1/organizations/federation_issuers

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

列出联合颁发者
organization.federation.issuers.list(**kwargs) -> SyncPageCursor[FederationIssuer]
GET/v1/organizations/federation_issuers

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

获取联合颁发者
organization.federation.issuers.retrieve(federation_issuer_id) -> FederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

更新联合颁发者
organization.federation.issuers.update(federation_issuer_id, **kwargs) -> FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

归档联合颁发者
organization.federation.issuers.archive(federation_issuer_id) -> FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

组织联合规则

创建联合规则
organization.federation.rules.create(**kwargs) -> FederationRule
POST/v1/organizations/federation_rules

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

列出联合规则
organization.federation.rules.list(**kwargs) -> SyncPageCursor[FederationRule]
GET/v1/organizations/federation_rules

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

获取联合规则
organization.federation.rules.retrieve(federation_rule_id) -> FederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

更新联合规则
organization.federation.rules.update(federation_rule_id, **kwargs) -> FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

归档联合规则
organization.federation.rules.archive(federation_rule_id) -> FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

组织联合规则工作区

添加联合规则工作区
organization.federation.rules.workspaces.add(federation_rule_id, **kwargs) -> FederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

列出联合规则工作区
organization.federation.rules.workspaces.list(federation_rule_id, **kwargs) -> SyncPageCursor[FederationRuleWorkspace]
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

移除联合规则工作区
organization.federation.rules.workspaces.remove(workspace_id, **kwargs) -> 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。

组织邀请

创建邀请
organization.invites.create(**kwargs) -> OrganizationInvite
POST/v1/organizations/invites

通过电子邮件邀请用户加入组织。

列出邀请
organization.invites.list(**kwargs) -> SyncPage[OrganizationInvite]
GET/v1/organizations/invites

列出组织的邀请。

获取邀请
organization.invites.retrieve(invite_id) -> OrganizationInvite
GET/v1/organizations/invites/{invite_id}

按 ID 检索邀请。

删除邀请
organization.invites.delete(invite_id) -> InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

删除待处理的邀请。

组织服务账号

创建服务账号
organization.service_accounts.create(**kwargs) -> ServiceAccount
POST/v1/organizations/service_accounts

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

列出服务账号
organization.service_accounts.list(**kwargs) -> SyncPageCursor[ServiceAccount]
GET/v1/organizations/service_accounts

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

获取服务账号
organization.service_accounts.retrieve(service_account_id) -> ServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

更新服务账号
organization.service_accounts.update(service_account_id, **kwargs) -> ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

归档服务账号
organization.service_accounts.archive(service_account_id) -> ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

组织服务账号工作区

将工作区添加到服务账号
organization.service_accounts.workspaces.add(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

列出服务账号所属的工作区
organization.service_accounts.workspaces.list(service_account_id, **kwargs) -> SyncPageCursor[ServiceAccountWorkspaceMember]
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

从服务账号中移除工作区
organization.service_accounts.workspaces.remove(workspace_id, **kwargs) -> 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。

组织用户

列出用户
organization.users.list(**kwargs) -> SyncPage[OrganizationUser]
GET/v1/organizations/users

列出组织的成员。

获取用户
organization.users.retrieve(user_id) -> OrganizationUser
GET/v1/organizations/users/{user_id}

按用户 ID 检索组织成员。

更新用户
organization.users.update(user_id, **kwargs) -> OrganizationUser
POST/v1/organizations/users/{user_id}

更新成员的组织角色。

移除用户
organization.users.remove(user_id) -> UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

将成员从组织中移除。

组织工作区

列出工作区
organization.workspaces.list(**kwargs) -> SyncPage[Workspace]
GET/v1/organizations/workspaces
创建工作区
organization.workspaces.create(**kwargs) -> Workspace
POST/v1/organizations/workspaces
获取工作区
organization.workspaces.retrieve(workspace_id) -> Workspace
GET/v1/organizations/workspaces/{workspace_id}
更新工作区
organization.workspaces.update(workspace_id, **kwargs) -> Workspace
POST/v1/organizations/workspaces/{workspace_id}
归档工作区
organization.workspaces.archive(workspace_id) -> Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

组织工作区速率限制

列出工作区速率限制
organization.workspaces.rate_limits.list(workspace_id, **kwargs) -> SyncPageCursor[WorkspaceRateLimit]
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

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

组织工作区成员

列出工作区成员
organization.workspaces.members.list(workspace_id, **kwargs) -> SyncPage[WorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/members
创建工作区成员
organization.workspaces.members.add(workspace_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
获取工作区成员
organization.workspaces.members.retrieve(user_id, **kwargs) -> WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作区成员
organization.workspaces.members.update(user_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
删除工作区成员
organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

组织工作区服务账号

列出服务账号工作区成员
organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> SyncPageCursor[ServiceAccountWorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

创建服务账号工作区成员
organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

获取服务账号工作区成员
organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> 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。

更新服务账号工作区成员
organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> 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。

删除服务账号工作区成员
organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> 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。

组织速率限制

列出组织速率限制
organization.rate_limits.list(**kwargs) -> SyncPageCursor[OrganizationRateLimit]
GET/v1/organizations/rate_limits

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

组织合规设置

获取合规设置
organization.compliance_settings.retrieve() -> OrganizationComplianceSettings
GET/v1/organizations/compliance_settings

检索您组织的合规设置。

更新合规设置
organization.compliance_settings.update(**kwargs) -> OrganizationComplianceSettings
POST/v1/organizations/compliance_settings

更新您组织的合规设置。