Claude Platform Docs

组织

获取当前组织
BetaOrganization beta().organization().retrieve(params = OrganizationRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/me

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

Models
class BetaOrganization { type = "organization"; id; name; }
JsonValue type = "organization"

Object type.

For Organizations, this is always "organization".

String id

ID of the Organization.

formatuuid
String name

Name of the Organization.

enum BetaOrganizationRole
ADMIN("admin")
BILLING("billing")
CLAUDE_CODE_USER("claude_code_user")
DEVELOPER("developer")
MANAGED("managed")
MEMBERSHIP_ADMIN("membership_admin")
OWNER("owner")
PRIMARY_OWNER("primary_owner")
USER("user")

组织API 密钥

列出 API 密钥
ApiKeyListPage beta().organization().apiKeys().list(params = ApiKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys
检索 API 密钥(Admin API)
BetaApiKey beta().organization().apiKeys().retrieve(params = ApiKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys/{api_key_id}

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

更新 API 密钥
BetaApiKey beta().organization().apiKeys().update(params = ApiKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/api_keys/{api_key_id}

组织外部密钥

创建外部密钥
BetaExternalKey beta().organization().externalKeys().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys

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

列出外部密钥
ExternalKeyListPage beta().organization().externalKeys().list(params = ExternalKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/external_keys

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

获取外部密钥
BetaExternalKey beta().organization().externalKeys().retrieve(params = ExternalKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/external_keys/{external_key_id}

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

更新外部密钥
BetaExternalKey beta().organization().externalKeys().update(params = ExternalKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}

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

删除外部密钥
ExternalKeyDeleteResponse beta().organization().externalKeys().delete(params = ExternalKeyDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/external_keys/{external_key_id}

删除外部密钥配置。

验证外部密钥
ExternalKeyValidateResponse beta().organization().externalKeys().validate(params = ExternalKeyValidateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}/validate

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

组织联合颁发者

创建联合颁发者
BetaFederationIssuer beta().organization().federation().issuers().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers

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

列出联合颁发者
IssuerListPage beta().organization().federation().issuers().list(params = IssuerListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers

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

获取联合颁发者
BetaFederationIssuer beta().organization().federation().issuers().retrieve(params = IssuerRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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

更新联合颁发者
BetaFederationIssuer beta().organization().federation().issuers().update(params = IssuerUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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

归档联合颁发者
BetaFederationIssuer beta().organization().federation().issuers().archive(params = IssuerArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

组织联合规则

创建联合规则
BetaFederationRule beta().organization().federation().rules().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules

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

列出联合规则
RuleListPage beta().organization().federation().rules().list(params = RuleListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules

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

获取联合规则
BetaFederationRule beta().organization().federation().rules().retrieve(params = RuleRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}

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

更新联合规则
BetaFederationRule beta().organization().federation().rules().update(params = RuleUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}

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

归档联合规则
BetaFederationRule beta().organization().federation().rules().archive(params = RuleArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

组织联合规则工作区

添加联合规则工作区
BetaFederationRuleWorkspace beta().organization().federation().rules().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

列出联合规则工作区
WorkspaceListPage beta().organization().federation().rules().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

移除联合规则工作区
WorkspaceRemoveResponse beta().organization().federation().rules().workspaces().remove(params, requestOptions = RequestOptions.none())
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。

组织邀请

创建邀请
BetaOrganizationInvite beta().organization().invites().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/invites

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

列出邀请
InviteListPage beta().organization().invites().list(params = InviteListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/invites

列出组织的邀请。

获取邀请
BetaOrganizationInvite beta().organization().invites().retrieve(params = InviteRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/invites/{invite_id}

按 ID 检索邀请。

删除邀请
InviteDeleteResponse beta().organization().invites().delete(params = InviteDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/invites/{invite_id}

删除待处理的邀请。

组织服务账号

创建服务账号
BetaServiceAccount beta().organization().serviceAccounts().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts

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

列出服务账号
ServiceAccountListPage beta().organization().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts

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

获取服务账号
BetaServiceAccount beta().organization().serviceAccounts().retrieve(params = ServiceAccountRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}

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

更新服务账号
BetaServiceAccount beta().organization().serviceAccounts().update(params = ServiceAccountUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}

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

归档服务账号
BetaServiceAccount beta().organization().serviceAccounts().archive(params = ServiceAccountArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/archive

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

组织服务账号工作区

将工作区添加到服务账号
BetaServiceAccountWorkspaceMember beta().organization().serviceAccounts().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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

列出服务账号所属的工作区
WorkspaceListPage beta().organization().serviceAccounts().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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

从服务账号中移除工作区
WorkspaceRemoveResponse beta().organization().serviceAccounts().workspaces().remove(params, requestOptions = RequestOptions.none())
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 beta().organization().users().list(params = UserListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/users

列出组织的成员。

获取用户
BetaOrganizationUser beta().organization().users().retrieve(params = UserRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/users/{user_id}

按用户 ID 检索组织成员。

更新用户
BetaOrganizationUser beta().organization().users().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/users/{user_id}

更新成员的组织角色。

移除用户
UserRemoveResponse beta().organization().users().remove(params = UserRemoveParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/users/{user_id}

将成员从组织中移除。

组织工作区

列出工作区
WorkspaceListPage beta().organization().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces
创建工作区
BetaWorkspace beta().organization().workspaces().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces
获取工作区
BetaWorkspace beta().organization().workspaces().retrieve(params = WorkspaceRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}
更新工作区
BetaWorkspace beta().organization().workspaces().update(params = WorkspaceUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}
归档工作区
BetaWorkspace beta().organization().workspaces().archive(params = WorkspaceArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/archive

组织工作区速率限制

列出工作区速率限制
RateLimitListPage beta().organization().workspaces().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

列出工作区的速率限制(rate limit)。

组织工作区成员

列出工作区成员
MemberListPage beta().organization().workspaces().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members
创建工作区成员
BetaWorkspaceMember beta().organization().workspaces().members().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members
获取工作区成员
BetaWorkspaceMember beta().organization().workspaces().members().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作区成员
BetaWorkspaceMember beta().organization().workspaces().members().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
删除工作区成员
MemberRemoveResponse beta().organization().workspaces().members().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

组织工作区服务账号

列出服务账号工作区成员
ServiceAccountListPage beta().organization().workspaces().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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

创建服务账号工作区成员
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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

获取服务账号工作区成员
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().retrieve(params, requestOptions = RequestOptions.none())
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。

更新服务账号工作区成员
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().update(params, requestOptions = RequestOptions.none())
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 beta().organization().workspaces().serviceAccounts().remove(params, requestOptions = RequestOptions.none())
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 beta().organization().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rate_limits

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

组织合规设置

获取合规设置
BetaComplianceSettings beta().organization().complianceSettings().retrieve(params = ComplianceSettingRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/compliance_settings

检索您组织的合规设置。

更新合规设置
BetaComplianceSettings beta().organization().complianceSettings().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/compliance_settings

更新您组织的合规设置。

组织分析摘要

获取活动摘要
SummaryListPage beta().organization().analytics().summaries().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/summaries

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

组织分析用户

列出用户活动
UserListPage beta().organization().analytics().users().list(params = UserListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/users

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

组织分析应用聊天项目

获取聊天项目用量
ProjectListPage beta().organization().analytics().apps().chat().projects().list(params = ProjectListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/apps/chat/projects

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

组织分析连接器

获取连接器使用情况
ConnectorListPage beta().organization().analytics().connectors().list(params = ConnectorListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/connectors

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

组织分析插件

获取插件使用情况
PluginListPage beta().organization().analytics().plugins().list(params = PluginListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/plugins

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

组织分析技能

获取技能使用情况
SkillListPage beta().organization().analytics().skills().list(params = SkillListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/skills

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

组织分析Artifacts

获取 Artifact 活动
ArtifactListPage beta().organization().analytics().artifacts().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/artifacts

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

组织分析使用情况报告

获取随时间变化的令牌用量
UsageReportListPage beta().organization().analytics().usageReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/usage_report

获取某个日期范围内随时间变化的令牌用量。

组织分析用户用量报告

获取每用户令牌用量
UserUsageReportListPage beta().organization().analytics().userUsageReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/user_usage_report

获取某个日期范围内的每用户令牌用量。

组织分析成本报告

获取随时间变化的成本
CostReportListPage beta().organization().analytics().costReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/cost_report

获取某个日期范围内随时间变化的成本(以美元计)。

组织分析用户成本报告

获取每用户成本
UserCostReportListPage beta().organization().analytics().userCostReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/user_cost_report

获取某个日期范围内的每用户成本(以美元计)。

组织支出限额

设置支出限额
BetaSpendLimit beta().organization().spendLimits().set(params, requestOptions = RequestOptions.none())
POST/v1/organizations/spend_limits

设置支出限额。

获取支出限额
BetaSpendLimit beta().organization().spendLimits().retrieve(params = SpendLimitRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limits/{spend_limit_id}

按 ID 检索支出限额。

删除支出限额
SpendLimitDeleteResponse beta().organization().spendLimits().delete(params = SpendLimitDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/spend_limits/{spend_limit_id}

删除支出限额。

列出支出限额
SpendLimitListPage beta().organization().spendLimits().list(params = SpendLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limits

列出组织的支出限额。

组织支出限额生效

列出生效的支出限额
EffectiveListPage beta().organization().spendLimits().effective().list(params = EffectiveListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limits/effective

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

组织支出限额提额请求

列出支出限额提额请求
IncreaseRequestListPage beta().organization().spendLimits().increaseRequests().list(params = IncreaseRequestListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limit_increase_requests

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

获取支出限额提额请求
BetaSpendLimitIncreaseRequest beta().organization().spendLimits().increaseRequests().retrieve(params = IncreaseRequestRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

检索支出限额提额请求。

批准支出限额提额请求
IncreaseRequestApproveResponse beta().organization().spendLimits().increaseRequests().approve(params, requestOptions = RequestOptions.none())
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

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

拒绝支出限额提额请求
BetaSpendLimitIncreaseRequest beta().organization().spendLimits().increaseRequests().deny(params = IncreaseRequestDenyParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

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

组织RBAC 组

创建 RBAC 组
BetaRbacGroup beta().organization().rbacGroups().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/rbac_groups

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

列出 RBAC 组
RbacGroupListPage beta().organization().rbacGroups().list(params = RbacGroupListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_groups

列出 Claude Enterprise 租户中的 RBAC 组。

获取 RBAC 组
BetaRbacGroup beta().organization().rbacGroups().retrieve(params = RbacGroupRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_groups/{rbac_group_id}

按 ID 检索 RBAC 组。

更新 RBAC 组
BetaRbacGroup beta().organization().rbacGroups().update(params = RbacGroupUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/rbac_groups/{rbac_group_id}

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

删除 RBAC 组
RbacGroupDeleteResponse beta().organization().rbacGroups().delete(params = RbacGroupDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

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

组织RBAC 组成员

列出 RBAC 组成员
MemberListPage beta().organization().rbacGroups().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

列出 RBAC 组的成员。

添加 RBAC 组成员
BetaRbacGroupMember beta().organization().rbacGroups().members().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

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

移除 RBAC 组成员
MemberRemoveResponse beta().organization().rbacGroups().members().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

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

组织RBAC 角色

列出 RBAC 角色
RbacRoleListPage beta().organization().rbacRoles().list(params = RbacRoleListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_roles

列出组织中的 RBAC 角色。

获取 RBAC 角色
BetaRbacRole beta().organization().rbacRoles().retrieve(params = RbacRoleRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_roles/{rbac_role_id}

按 ID 检索 RBAC 角色。

组织RBAC 角色权限

列出 RBAC 角色权限
PermissionListPage beta().organization().rbacRoles().permissions().list(params = PermissionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

列出 RBAC 角色授予的权限。

组织插件

创建插件
BetaPlugin beta().organization().plugins().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins

通过上传版本文件,创建组织拥有的插件及其第一个版本。

获取插件
BetaPlugin beta().organization().plugins().retrieve(params = PluginRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}

按 ID 检索插件。

更新插件
BetaPlugin beta().organization().plugins().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins/{plugin_id}

更改向成员提供的组织所有插件的已存储版本,例如回滚到较早的版本。此操作会固定所提供的版本:之后上传的版本仍会被存储,但不再改变所提供的内容,并且固定目前无法撤销,无论是在此处还是在 claude.ai 中。

列出插件
PluginListPage beta().organization().plugins().list(params = PluginListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins

列出在组织下创建的插件,按从新到旧排序:包括组织自有插件市场中的插件以及成员个人插件市场中的插件。

删除插件
BetaDeletedPlugin beta().organization().plugins().delete(params = PluginDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/plugins/{plugin_id}

永久删除一个插件及其包含的所有版本,效果与管理员在 claude.ai 中删除它完全相同。该插件可以属于组织,也可以属于某个成员,包括此后已离开组织的成员。

组织插件版本

创建插件版本
BetaPluginVersion beta().organization().plugins().versions().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins/{plugin_id}/versions

通过上传新版本的文件为组织所有的插件添加一个版本;除非该插件的提供版本已被固定,否则新版本将成为向成员提供的版本。

列出插件版本
VersionListPage beta().organization().plugins().versions().list(params = VersionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/versions

列出插件的版本,按从新到旧排序。

获取插件版本
BetaPluginVersion beta().organization().plugins().versions().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

按 ID 检索插件的某个版本,或检索插件的最新版本。

下载插件版本归档
HttpResponse beta().organization().plugins().versions().download(params, requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

按原样下载某个版本的 .zip 归档文件。每次从成员个人插件市场下载插件都会记录在 Compliance API 活动源中。

组织插件安装设置

列出插件安装设置
InstallationSettingListPage beta().organization().plugins().installationSettings().list(params = InstallationSettingListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/installation_settings

列出组织所有插件的安装设置(这些设置说明插件面向哪些成员),按创建时间从新到旧排序。

设置插件安装设置
BetaPluginInstallationSetting beta().organization().plugins().installationSettings().set(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

为整个组织或某个 RBAC 组设置或更改组织所有插件的安装设置。

移除插件安装设置
BetaDeletedPluginInstallationSetting beta().organization().plugins().installationSettings().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

移除组织所有插件针对整个组织或某个 RBAC 组的自身安装设置。

组织插件共享

列出插件共享
ShareListPage beta().organization().plugins().shares().list(params = ShareListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/shares

列出成员所有插件的所有者所授予的共享(共享给组织的所有成员、某个 RBAC 组或某个成员),按授予时间从新到旧排序。

组织插件市场

列出插件市场
PluginMarketplaceListPage beta().organization().pluginMarketplaces().list(params = PluginMarketplaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugin_marketplaces

列出插件所在的插件市场,按从新到旧排序:包括组织自有的市场及其成员的个人市场。

获取插件市场
BetaPluginMarketplace beta().organization().pluginMarketplaces().retrieve(params = PluginMarketplaceRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

按 ID 检索插件市场。

更新插件市场
BetaPluginMarketplace beta().organization().pluginMarketplaces().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

设置组织自有插件市场之一的默认安装设置。该市场中所有没有自身设置的插件(包括之后添加的插件)都会将此默认值作为其组织范围设置。

验证插件市场代码仓库
BetaPluginMarketplaceValidationReport beta().organization().pluginMarketplaces().validateRepository(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugin_marketplaces/validate_repository

检查存放在公共 GitHub 代码仓库中的插件市场能否同步到 claude.ai,而不会连接或存储该市场。

验证插件市场归档
BetaPluginMarketplaceValidationReport beta().organization().pluginMarketplaces().validateArchive(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugin_marketplaces/validate_archive

检查以市场目录 .zip 文件形式上传的插件市场能否同步到 claude.ai,而不会连接或存储该市场。

组织遥测目标

创建遥测目标
BetaTelemetryDestination beta().organization().telemetryDestinations().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations

为组织注册一个 OpenTelemetry 目标。

列出遥测目标
TelemetryDestinationListPage beta().organization().telemetryDestinations().list(params = TelemetryDestinationListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/telemetry_destinations

列出组织的目标,最新的排在最前,可选择仅列出覆盖指定工作区的目标。

检索遥测目标
BetaTelemetryDestination beta().organization().telemetryDestinations().retrieve(params = TelemetryDestinationRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/telemetry_destinations/{destination_id}

读取目标的配置、状态和最近的投递结果。

更新遥测目标
BetaTelemetryDestination beta().organization().telemetryDestinations().update(params = TelemetryDestinationUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations/{destination_id}

更改遥测目标的设置、状态或其覆盖的工作区。

删除遥测目标
BetaDeletedTelemetryDestination beta().organization().telemetryDestinations().delete(params = TelemetryDestinationDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/telemetry_destinations/{destination_id}

删除目标及其工作区列表。

测试遥测目标
BetaTelemetryDestinationTestResponse beta().organization().telemetryDestinations().test(params = TelemetryDestinationTestParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations/{destination_id}/test

使用目标已注册的标头向其发送一个名为 anthropic.test 的测试 span,仅发送一次且不重试,并报告目标的响应。无论目标是否以 2xx 状态响应,响应均为 200:其 result 的类型为 success,或类型为 failure 并在 error 中给出原因。目标的配置、state 和 delivery_health 不会改变。已禁用的目标也可以测试。对同一目标的两次测试之间请等待 10 秒;过早发出的请求可能会收到 429 状态。

组织遥测目标工作区

列出遥测目标工作区
WorkspaceListPage beta().organization().telemetryDestinations().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces

列出目标工作区列表中的工作区,最新条目排在最前。

添加遥测目标工作区
BetaTelemetryDestinationWorkspace beta().organization().telemetryDestinations().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

向目标的工作区列表中添加一个工作区。

移除遥测目标工作区
BetaDeletedTelemetryDestinationWorkspace beta().organization().telemetryDestinations().workspaces().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

从目标的工作区列表中移除一个工作区。