Claude Platform Docs

组织

获取当前组织
GET/v1/organizations/me

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

Models
ConcurrentMembershipChangeErrorDetails object{ error_code }

Another change to the organization's members is in progress. Retry the request once it completes.

error_code: "concurrent_membership_change"
OrgMemberLimitExceededErrorDetails object{ error_code }

The organization has reached the member limit that Anthropic set for it. Pending invites count toward the limit.

error_code: "org_member_limit_exceeded"
OrganizationInfo object{ 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.

OrganizationRole = "admin" or "billing" or "claude_code_user" or 6 more
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
RBACRoleNotFoundErrorDetails object{ error_code }

No RBAC Role with this ID was found.

error_code: "rbac_role_not_found"

组织API 密钥

列出 API 密钥
GET/v1/organizations/api_keys
检索 API 密钥（Admin API）
GET/v1/organizations/api_keys/{api_key_id}

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

更新 API 密钥
POST/v1/organizations/api_keys/{api_key_id}

组织外部密钥

创建外部密钥
POST/v1/organizations/external_keys

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

列出外部密钥
GET/v1/organizations/external_keys

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

获取外部密钥
GET/v1/organizations/external_keys/{external_key_id}

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

更新外部密钥
POST/v1/organizations/external_keys/{external_key_id}

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

删除外部密钥
DELETE/v1/organizations/external_keys/{external_key_id}

删除外部密钥配置。

验证外部密钥
POST/v1/organizations/external_keys/{external_key_id}/validate

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

组织联合颁发者

创建联合颁发者
POST/v1/organizations/federation_issuers

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

列出联合颁发者
GET/v1/organizations/federation_issuers

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

获取联合颁发者
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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

更新联合颁发者
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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

归档联合颁发者
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

组织联合规则

创建联合规则
POST/v1/organizations/federation_rules

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

列出联合规则
GET/v1/organizations/federation_rules

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

获取联合规则
GET/v1/organizations/federation_rules/{federation_rule_id}

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

更新联合规则
POST/v1/organizations/federation_rules/{federation_rule_id}

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

归档联合规则
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

组织联合规则工作区

添加联合规则工作区
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

列出联合规则工作区
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

移除联合规则工作区
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。

组织邀请

创建邀请
POST/v1/organizations/invites

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

列出邀请
GET/v1/organizations/invites

列出组织的邀请。

获取邀请
GET/v1/organizations/invites/{invite_id}

按 ID 检索邀请。

删除邀请
DELETE/v1/organizations/invites/{invite_id}

删除待处理的邀请。

组织服务账号

创建服务账号
POST/v1/organizations/service_accounts

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

列出服务账号
GET/v1/organizations/service_accounts

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

获取服务账号
GET/v1/organizations/service_accounts/{service_account_id}

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

更新服务账号
POST/v1/organizations/service_accounts/{service_account_id}

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

归档服务账号
POST/v1/organizations/service_accounts/{service_account_id}/archive

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

组织服务账号工作区

将工作区添加到服务账号
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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

列出服务账号所属的工作区
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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

从服务账号中移除工作区
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。

组织用户

列出用户
GET/v1/organizations/users

列出组织的成员。

获取用户
GET/v1/organizations/users/{user_id}

按用户 ID 检索组织成员。

更新用户
POST/v1/organizations/users/{user_id}

更新成员的组织角色。

移除用户
DELETE/v1/organizations/users/{user_id}

将成员从组织中移除。

组织工作区

列出工作区
GET/v1/organizations/workspaces
创建工作区
POST/v1/organizations/workspaces
获取工作区
GET/v1/organizations/workspaces/{workspace_id}
更新工作区
POST/v1/organizations/workspaces/{workspace_id}
归档工作区
POST/v1/organizations/workspaces/{workspace_id}/archive

组织工作区速率限制

列出工作区速率限制
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

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

设置工作区速率限制
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

为工作区中的某个速率限制组设置或清除速率限制覆盖值。

组织工作区成员

列出工作区成员
GET/v1/organizations/workspaces/{workspace_id}/members
创建工作区成员
POST/v1/organizations/workspaces/{workspace_id}/members
获取工作区成员
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作区成员
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
删除工作区成员
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

组织工作区服务账号

列出服务账号工作区成员
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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

创建服务账号工作区成员
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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

获取服务账号工作区成员
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。

更新服务账号工作区成员
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。

删除服务账号工作区成员
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。

组织速率限制

列出组织速率限制
GET/v1/organizations/rate_limits

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

组织合规设置

获取合规设置
GET/v1/organizations/compliance_settings

检索您组织的合规设置。

更新合规设置
POST/v1/organizations/compliance_settings

更新您组织的合规设置。

组织分析摘要

获取活动摘要
GET/v1/organizations/analytics/summaries

获取某个日期范围内的组织级活动摘要。

组织分析用户

列出用户活动
GET/v1/organizations/analytics/users

获取给定日期的每用户活动，支持基于游标的分页。

组织分析应用聊天项目

获取聊天项目用量
GET/v1/organizations/analytics/apps/chat/projects

获取指定日期的每项目活动，支持基于游标的分页。

组织分析连接器

获取连接器使用情况
GET/v1/organizations/analytics/connectors

获取给定日期的每连接器使用情况，支持基于游标的分页。

组织分析插件

获取插件使用情况
GET/v1/organizations/analytics/plugins

获取给定日期的每插件安装 + 调用使用情况，支持分页。

组织分析技能

获取技能使用情况
GET/v1/organizations/analytics/skills

获取给定日期的每技能使用情况，支持基于游标的分页。

组织分析Artifacts

获取 Artifact 活动
GET/v1/organizations/analytics/artifacts

获取给定日期的 Artifact 创建活动，按 MIME 类型细分。

组织支出限额生效

列出生效的支出限额
GET/v1/organizations/spend_limits/effective

列出每位成员的生效支出限额及本周期至今的支出。

组织支出限额提额请求

列出支出限额提额请求
GET/v1/organizations/spend_limit_increase_requests

列出支出限额提额请求，最新的在前。

获取支出限额提额请求
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

检索支出限额提额请求。

批准支出限额提额请求
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

批准待处理的支出限额提额请求。

拒绝支出限额提额请求
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

拒绝待处理的支出限额提额请求。

组织RBAC 组

创建 RBAC 组
POST/v1/organizations/rbac_groups

在 Claude Enterprise 租户中创建 RBAC 组。通过 API 创建的组的来源类型为 "direct"。

列出 RBAC 组
GET/v1/organizations/rbac_groups

列出 Claude Enterprise 租户中的 RBAC 组。

获取 RBAC 组
GET/v1/organizations/rbac_groups/{rbac_group_id}

按 ID 检索 RBAC 组。

更新 RBAC 组
POST/v1/organizations/rbac_groups/{rbac_group_id}

更新 RBAC 组的名称。当租户中的某个组织使用 SCIM 预配时，由身份提供商预配的组（来源类型为 "scim"）无法通过 API 修改。

删除 RBAC 组
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

删除 RBAC 组。当租户中的某个组织使用 SCIM 预配时，由身份提供商预配的组（来源类型为 "scim"）无法通过 API 删除。

组织RBAC 组成员

列出 RBAC 组成员
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

列出 RBAC 组的成员。

添加 RBAC 组成员
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

将用户添加到 RBAC 组。当租户中的某个组织使用 SCIM 预配时，由身份提供商预配的组（来源类型为 "scim"）的成员资格无法通过 API 修改。

移除 RBAC 组成员
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

从 RBAC 组中移除用户。当租户中的某个组织使用 SCIM 预配时，由身份提供商预配的组（来源类型为 "scim"）的成员资格无法通过 API 修改。

组织RBAC 角色

列出 RBAC 角色
GET/v1/organizations/rbac_roles

列出组织中的 RBAC 角色。

获取 RBAC 角色
GET/v1/organizations/rbac_roles/{rbac_role_id}

按 ID 检索 RBAC 角色。

组织RBAC 角色权限

列出 RBAC 角色权限
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

列出 RBAC 角色授予的权限。