Claude Platform Docs

组织

获取当前组织
OrganizationInfo Organization.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/me

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

Models
class OrganizationInfo { Type = "organization"; ID; Name; }
JsonElement Type = "organization"

Object type.

For Organizations, this is always "organization".

required string ID

ID of the Organization.

formatuuid
required string Name

Name of the Organization.

enum OrganizationRole
Admin("admin")
Billing("billing")
ClaudeCodeUser("claude_code_user")
Developer("developer")
Managed("managed")
MembershipAdmin("membership_admin")
Owner("owner")
PrimaryOwner("primary_owner")
User("user")

组织API 密钥

列出 API 密钥
ApiKeyListPage Organization.ApiKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
检索 API 密钥（Admin API）
ApiKey Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/api_keys/{api_key_id}

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

更新 API 密钥
ApiKey Organization.ApiKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}

组织外部密钥

创建外部密钥
ExternalKey Organization.ExternalKeys.Create(parameters, cancellationToken = default)
POST/v1/organizations/external_keys

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

列出外部密钥
ExternalKeyListPage Organization.ExternalKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/external_keys

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

获取外部密钥
ExternalKey Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/external_keys/{external_key_id}

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

更新外部密钥
ExternalKey Organization.ExternalKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}

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

删除外部密钥
ExternalKeyDeleteResponse Organization.ExternalKeys.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/external_keys/{external_key_id}

删除外部密钥配置。

验证外部密钥
ExternalKeyValidateResponse Organization.ExternalKeys.Validate(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}/validate

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

组织联合颁发者

创建联合颁发者
FederationIssuer Organization.Federation.Issuers.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers

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

列出联合颁发者
IssuerListPage Organization.Federation.Issuers.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers

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

获取联合颁发者
FederationIssuer Organization.Federation.Issuers.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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

更新联合颁发者
FederationIssuer Organization.Federation.Issuers.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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

归档联合颁发者
FederationIssuer Organization.Federation.Issuers.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

组织联合规则

创建联合规则
FederationRule Organization.Federation.Rules.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules

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

列出联合规则
RuleListPage Organization.Federation.Rules.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules

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

获取联合规则
FederationRule Organization.Federation.Rules.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}

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

更新联合规则
FederationRule Organization.Federation.Rules.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}

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

归档联合规则
FederationRule Organization.Federation.Rules.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

组织联合规则工作区

添加联合规则工作区
FederationRuleWorkspace Organization.Federation.Rules.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

列出联合规则工作区
WorkspaceListPage Organization.Federation.Rules.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

移除联合规则工作区
WorkspaceRemoveResponse Organization.Federation.Rules.Workspaces.Remove(parameters, cancellationToken = default)
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。

组织邀请

创建邀请
OrganizationInvite Organization.Invites.Create(parameters, cancellationToken = default)
POST/v1/organizations/invites

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

列出邀请
InviteListPage Organization.Invites.List(parameters, cancellationToken = default)
GET/v1/organizations/invites

列出组织的邀请。

获取邀请
OrganizationInvite Organization.Invites.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/invites/{invite_id}

按 ID 检索邀请。

删除邀请
InviteDeleteResponse Organization.Invites.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/invites/{invite_id}

删除待处理的邀请。

组织服务账号

创建服务账号
ServiceAccount Organization.ServiceAccounts.Create(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts

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

列出服务账号
ServiceAccountListPage Organization.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts

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

获取服务账号
ServiceAccount Organization.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}

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

更新服务账号
ServiceAccount Organization.ServiceAccounts.Update(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}

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

归档服务账号
ServiceAccount Organization.ServiceAccounts.Archive(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/archive

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

组织服务账号工作区

将工作区添加到服务账号
ServiceAccountWorkspaceMember Organization.ServiceAccounts.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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

列出服务账号所属的工作区
WorkspaceListPage Organization.ServiceAccounts.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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

从服务账号中移除工作区
WorkspaceRemoveResponse Organization.ServiceAccounts.Workspaces.Remove(parameters, cancellationToken = default)
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。

组织用户

列出用户
UserListPage Organization.Users.List(parameters, cancellationToken = default)
GET/v1/organizations/users

列出组织的成员。

获取用户
OrganizationUser Organization.Users.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/users/{user_id}

按用户 ID 检索组织成员。

更新用户
OrganizationUser Organization.Users.Update(parameters, cancellationToken = default)
POST/v1/organizations/users/{user_id}

更新成员的组织角色。

移除用户
UserRemoveResponse Organization.Users.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/users/{user_id}

将成员从组织中移除。

组织工作区

列出工作区
WorkspaceListPage Organization.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces
创建工作区
Workspace Organization.Workspaces.Create(parameters, cancellationToken = default)
POST/v1/organizations/workspaces
获取工作区
Workspace Organization.Workspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}
更新工作区
Workspace Organization.Workspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}
归档工作区
Workspace Organization.Workspaces.Archive(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/archive

组织工作区速率限制

列出工作区速率限制
RateLimitListPage Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

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

设置工作区速率限制
WorkspaceRateLimit Organization.Workspaces.RateLimits.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

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

组织工作区成员

列出工作区成员
MemberListPage Organization.Workspaces.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members
创建工作区成员
WorkspaceMember Organization.Workspaces.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members
获取工作区成员
WorkspaceMember Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作区成员
WorkspaceMember Organization.Workspaces.Members.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
删除工作区成员
MemberRemoveResponse Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

组织工作区服务账号

列出服务账号工作区成员
ServiceAccountListPage Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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

创建服务账号工作区成员
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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

获取服务账号工作区成员
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
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。

更新服务账号工作区成员
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Update(parameters, cancellationToken = default)
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。

删除服务账号工作区成员
ServiceAccountRemoveResponse Organization.Workspaces.ServiceAccounts.Remove(parameters, cancellationToken = default)
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。

组织速率限制

列出组织速率限制
RateLimitListPage Organization.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/rate_limits

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

组织合规设置

获取合规设置
OrganizationComplianceSettings Organization.ComplianceSettings.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/compliance_settings

检索您组织的合规设置。

更新合规设置
OrganizationComplianceSettings Organization.ComplianceSettings.Update(parameters, cancellationToken = default)
POST/v1/organizations/compliance_settings

Update your organization's Compliance Settings.