组织 - Claude API Reference

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

组织速率限制

列出组织速率限制

$ ant beta:organization:rate-limits list

GET/v1/organizations/rate_limits

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

组织合规设置

获取合规设置

$ ant beta:organization:compliance-settings retrieve

GET/v1/organizations/compliance_settings

检索您组织的合规设置。

更新合规设置

$ ant beta:organization:compliance-settings update

POST/v1/organizations/compliance_settings

更新您组织的合规设置。

组织分析摘要

获取活动摘要

$ ant beta:organization:analytics:summaries list

GET/v1/organizations/analytics/summaries

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

组织分析用户

列出用户活动

$ ant beta:organization:analytics:users list

GET/v1/organizations/analytics/users

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

组织分析应用聊天项目

获取聊天项目用量

$ ant beta:organization:analytics:apps:chat:projects list

GET/v1/organizations/analytics/apps/chat/projects

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

组织分析连接器

获取连接器使用情况

$ ant beta:organization:analytics:connectors list

GET/v1/organizations/analytics/connectors

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

组织分析插件

获取插件使用情况

$ ant beta:organization:analytics:plugins list

GET/v1/organizations/analytics/plugins

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

组织分析技能

获取技能使用情况

$ ant beta:organization:analytics:skills list

GET/v1/organizations/analytics/skills

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

组织分析Artifacts

获取 Artifact 活动

$ ant beta:organization:analytics:artifacts list

GET/v1/organizations/analytics/artifacts

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

组织分析使用情况报告

获取随时间变化的令牌用量

$ ant beta:organization:analytics:usage-report list

GET/v1/organizations/analytics/usage_report

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

组织分析用户用量报告

获取每用户令牌用量

$ ant beta:organization:analytics:user-usage-report list

GET/v1/organizations/analytics/user_usage_report

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

组织分析成本报告

获取随时间变化的成本

$ ant beta:organization:analytics:cost-report list

GET/v1/organizations/analytics/cost_report

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

组织分析用户成本报告

获取每用户成本

$ ant beta:organization:analytics:user-cost-report list

GET/v1/organizations/analytics/user_cost_report

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

组织支出限额

设置支出限额

$ ant beta:organization:spend-limits set

POST/v1/organizations/spend_limits

设置支出限额。

获取支出限额

$ ant beta:organization:spend-limits retrieve

GET/v1/organizations/spend_limits/{spend_limit_id}

按 ID 检索支出限额。

删除支出限额

$ ant beta:organization:spend-limits delete

DELETE/v1/organizations/spend_limits/{spend_limit_id}

删除支出限额。

列出支出限额

$ ant beta:organization:spend-limits list

GET/v1/organizations/spend_limits

List the organization's spend limits.

组织支出限额生效

列出生效的支出限额

$ ant beta:organization:spend-limits:effective list

GET/v1/organizations/spend_limits/effective

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

组织支出限额提额请求

列出支出限额提额请求

$ ant beta:organization:spend-limits:increase-requests list

GET/v1/organizations/spend_limit_increase_requests

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

获取支出限额提额请求

$ ant beta:organization:spend-limits:increase-requests retrieve

GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

检索支出限额提额请求。

批准支出限额提额请求

$ ant beta:organization:spend-limits:increase-requests approve

POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

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

拒绝支出限额提额请求

$ ant beta:organization:spend-limits:increase-requests deny

POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

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

组织RBAC 组

创建 RBAC 组

$ ant beta:organization:rbac-groups create

POST/v1/organizations/rbac_groups

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

列出 RBAC 组

$ ant beta:organization:rbac-groups list

GET/v1/organizations/rbac_groups

列出 Claude Enterprise 租户中的 RBAC 组。

获取 RBAC 组

$ ant beta:organization:rbac-groups retrieve

GET/v1/organizations/rbac_groups/{rbac_group_id}

按 ID 检索 RBAC 组。

更新 RBAC 组

$ ant beta:organization:rbac-groups update

POST/v1/organizations/rbac_groups/{rbac_group_id}

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

删除 RBAC 组

$ ant beta:organization:rbac-groups delete

DELETE/v1/organizations/rbac_groups/{rbac_group_id}

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

组织RBAC 组成员

列出 RBAC 组成员

$ ant beta:organization:rbac-groups:members list

GET/v1/organizations/rbac_groups/{rbac_group_id}/members

列出 RBAC 组的成员。

添加 RBAC 组成员

$ ant beta:organization:rbac-groups:members add

POST/v1/organizations/rbac_groups/{rbac_group_id}/members

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

移除 RBAC 组成员

$ ant beta:organization:rbac-groups:members remove

DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

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

组织RBAC 角色

列出 RBAC 角色

$ ant beta:organization:rbac-roles list

GET/v1/organizations/rbac_roles

列出组织中的 RBAC 角色。

获取 RBAC 角色

$ ant beta:organization:rbac-roles retrieve

GET/v1/organizations/rbac_roles/{rbac_role_id}

按 ID 检索 RBAC 角色。

组织RBAC 角色权限

列出 RBAC 角色权限

$ ant beta:organization:rbac-roles:permissions list

GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

列出 RBAC 角色授予的权限。

组织插件

创建插件

$ ant beta:organization:plugins create

POST/v1/organizations/plugins

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

获取插件

$ ant beta:organization:plugins retrieve

GET/v1/organizations/plugins/{plugin_id}

按 ID 检索插件。

更新插件

$ ant beta:organization:plugins update

POST/v1/organizations/plugins/{plugin_id}

Change which stored version of an organization-owned Plugin is served to members, for example to roll back to an earlier one. This pins the served version: later uploads are stored but no longer change what is served, and pinning cannot currently be undone, here or in claude.ai.

列出插件

$ ant beta:organization:plugins list

GET/v1/organizations/plugins

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

删除插件

$ ant beta:organization:plugins delete

DELETE/v1/organizations/plugins/{plugin_id}

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

组织插件版本

创建插件版本

$ ant beta:organization:plugins:versions create

POST/v1/organizations/plugins/{plugin_id}/versions

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

列出插件版本

$ ant beta:organization:plugins:versions list

GET/v1/organizations/plugins/{plugin_id}/versions

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

获取插件版本

$ ant beta:organization:plugins:versions retrieve

GET/v1/organizations/plugins/{plugin_id}/versions/{version}

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

下载插件版本归档

$ ant beta:organization:plugins:versions download

GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

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

组织插件安装设置

列出插件安装设置

$ ant beta:organization:plugins:installation-settings list

GET/v1/organizations/plugins/{plugin_id}/installation_settings

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

设置插件安装设置

$ ant beta:organization:plugins:installation-settings set

POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

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

移除插件安装设置

$ ant beta:organization:plugins:installation-settings remove

DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

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

组织插件共享

列出插件共享

$ ant beta:organization:plugins:shares list

GET/v1/organizations/plugins/{plugin_id}/shares

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

组织插件市场

列出插件市场

$ ant beta:organization:plugin-marketplaces list

GET/v1/organizations/plugin_marketplaces

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

获取插件市场

$ ant beta:organization:plugin-marketplaces retrieve

GET/v1/organizations/plugin_marketplaces/{marketplace_id}

按 ID 检索插件市场。

更新插件市场

$ ant beta:organization:plugin-marketplaces update

POST/v1/organizations/plugin_marketplaces/{marketplace_id}

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

验证插件市场代码仓库

$ ant beta:organization:plugin-marketplaces validate-repository

POST/v1/organizations/plugin_marketplaces/validate_repository

Check whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it.

验证插件市场归档

$ ant beta:organization:plugin-marketplaces validate-archive

POST/v1/organizations/plugin_marketplaces/validate_archive

Check whether a plugin marketplace, uploaded as a .zip of the marketplace directory, would synchronize into claude.ai, without connecting or storing it.

组织遥测目标

创建遥测目标

$ ant beta:organization:telemetry-destinations create

POST/v1/organizations/telemetry_destinations

为组织注册一个 OpenTelemetry 目标。

列出遥测目标

$ ant beta:organization:telemetry-destinations list

GET/v1/organizations/telemetry_destinations

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

检索遥测目标

$ ant beta:organization:telemetry-destinations retrieve

GET/v1/organizations/telemetry_destinations/{destination_id}

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

更新遥测目标

$ ant beta:organization:telemetry-destinations update

POST/v1/organizations/telemetry_destinations/{destination_id}

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

删除遥测目标

$ ant beta:organization:telemetry-destinations delete

DELETE/v1/organizations/telemetry_destinations/{destination_id}

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

测试遥测目标

$ ant beta:organization:telemetry-destinations test

POST/v1/organizations/telemetry_destinations/{destination_id}/test

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

组织遥测目标工作区

列出遥测目标工作区

$ ant beta:organization:telemetry-destinations:workspaces list

GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces

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

添加遥测目标工作区

$ ant beta:organization:telemetry-destinations:workspaces add

POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

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

移除遥测目标工作区

$ ant beta:organization:telemetry-destinations:workspaces remove

DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

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

组织Webhook

创建组织 Webhook 端点

$ ant beta:organization:webhooks create

POST/v1/organizations/webhooks

创建组织 webhook 端点。

列出组织 Webhook 端点

$ ant beta:organization:webhooks list

GET/v1/organizations/webhooks

列出组织的 webhook 端点。

获取组织 Webhook 端点

$ ant beta:organization:webhooks retrieve

GET/v1/organizations/webhooks/{webhook_endpoint_id}

按 ID 检索组织 webhook 端点。

更新组织 Webhook 端点

$ ant beta:organization:webhooks update

POST/v1/organizations/webhooks/{webhook_endpoint_id}

更新组织 webhook 端点。仅更改您发送的字段。

删除组织 Webhook 端点

$ ant beta:organization:webhooks delete

DELETE/v1/organizations/webhooks/{webhook_endpoint_id}

删除组织 webhook 端点。

重新生成组织 Webhook 端点签名密钥

$ ant beta:organization:webhooks regenerate-signing-secret

POST/v1/organizations/webhooks/{webhook_endpoint_id}/regenerate_signing_secret

替换组织 webhook 端点的签名密钥。旧密钥会立即失效。新密钥仅在此响应中返回。

组织Claude TagSlack Channels

Set Up Slack Channel

$ ant beta:organization:claude-tag:slack-channels create

POST/v1/organizations/claude_tag/slack_channels

Set a Slack channel up for Claude Tag and return it with its identifier. If the channel is already set up, whether in claude.ai, by Claude's first use in it or by an earlier request, the existing channel is returned, so the request can be repeated. settings, when sent, is applied as an update applies it. Before a channel is set up, Claude's Slack app confirms with Slack that the channel is in the workspace, is not archived and is visible to the app; a channel that fails the confirmation returns 404. Setting the channel up and applying settings are two steps: when the second is refused, the response is the refusal, the channel stays set up with every setting unset, and the error's details.slack_channel_id holds the channel's identifier.

List Slack Channels

$ ant beta:organization:claude-tag:slack-channels list

GET/v1/organizations/claude_tag/slack_channels

List the set-up Slack channels of one Slack workspace, newest first by created_at. A channel that is not set up is not listed: Slack holds the full list of a workspace's channels. Pass slack_channel_id as well to look one channel up by its Slack identifiers: data then holds that channel, or is empty when it is not set up, and limit and page are ignored. With include_inherited=true each channel's settings holds what applies in it, and the request fails with 503 rather than resolve against a settings level that could not be read. A page cursor resumes only a request with the same include_inherited.

Get Slack Channel

$ ant beta:organization:claude-tag:slack-channels retrieve

GET/v1/organizations/claude_tag/slack_channels/{id}

Get one Slack channel and its settings. By default settings holds what the channel itself stores: a setting that is null there is not set on the channel and is inherited. With include_inherited=true, settings holds what applies in the channel once the settings levels above it are taken into account, and the request fails with 503 rather than resolve against a settings level that could not be read. Either way sources names the settings level each value comes from, so a caller tells the channel's own value from an inherited one by its source, not by whether it is null.

Update Slack Channel

$ ant beta:organization:claude-tag:slack-channels update

POST/v1/organizations/claude_tag/slack_channels/{id}

Change the settings a Slack channel stores. The update is partial: a setting left out is unchanged, and a setting sent as null is cleared, so the channel inherits it. If any value is refused, no setting in the request is stored. A group direct message takes no settings and returns 400.

Remove Slack Channel

$ ant beta:organization:claude-tag:slack-channels delete

DELETE/v1/organizations/claude_tag/slack_channels/{id}

Remove a Slack channel from Claude Tag. This deletes the channel's stored settings and its Bundle Targets at once, and then, in the background, the channel's sessions and their transcripts, its memory, its routines and the artifacts published from it. None of it can be restored. The channel in Slack and its messages are unchanged. The request is refused with 400 and error.details.error_code slack_channel_enabled while enabled resolves to true for the channel, as a read with include_inherited=true returns it: set enabled to false on the channel first. This guards against removing a channel in use by mistake; it is not a way to keep Claude out, because the removal deletes the channel's own enabled: false with its other settings, after which the channel inherits again and Claude's next use of it can set it up anew with a new identifier. The identifier returns 404 as soon as the request returns, so a repeated removal returns 404. A group direct message returns 400, and so does a channel that holds configuration this API does not manage.

组织Claude TagSlack Workspaces

List Slack Workspaces

$ ant beta:organization:claude-tag:slack-workspaces list

GET/v1/organizations/claude_tag/slack_workspaces

List the set-up Slack workspaces the organization owns, newest first by created_at. Pass slack_workspace_id to look one workspace up by its Slack identifier: data then holds that workspace, or is empty when it is not set up. With include_inherited=true each workspace's settings holds what applies in it, and the request fails with 503 rather than resolve against a settings level that could not be read. A page cursor resumes only a request with the same include_inherited.

Get Slack Workspace

$ ant beta:organization:claude-tag:slack-workspaces retrieve

GET/v1/organizations/claude_tag/slack_workspaces/{id}

Get one Slack workspace and its settings. By default settings holds what the workspace itself stores: a setting that is null there is not set on the workspace and is inherited. With include_inherited=true, settings holds what applies in the workspace once the organization's Slack defaults are taken into account, and the request fails with 503 rather than resolve against a settings level that could not be read. Either way sources names the settings level each value comes from.

Update Slack Workspace

$ ant beta:organization:claude-tag:slack-workspaces update

POST/v1/organizations/claude_tag/slack_workspaces/{id}

Change the settings a Slack workspace stores. The update is partial: a setting left out is unchanged, and a setting sent as null is cleared, so the workspace inherits it. If any value is refused, no setting in the request is stored.

组织Claude TagBundles

List Bundles

$ ant beta:organization:claude-tag:bundles list

GET/v1/organizations/claude_tag/bundles

List the organization's Bundles, newest first by created_at. A Bundle that Claude Tag manages for itself is not listed.

Get Bundle

$ ant beta:organization:claude-tag:bundles retrieve

GET/v1/organizations/claude_tag/bundles/{bundle_id}

Get one Bundle. What the Bundle grants (connectors, repositories and credentials) is never returned.

组织Claude TagBundlesTargets

List Bundle Targets

$ ant beta:organization:claude-tag:bundles:targets list

GET/v1/organizations/claude_tag/bundles/{bundle_id}/targets

List the Slack channels and Slack workspaces a Bundle is attached to, newest first by created_at. Only channels and workspaces the organization owns are listed; a Bundle that is attached to anything else has no Bundle Target for it.

Attach Bundle

$ ant beta:organization:claude-tag:bundles:targets create

POST/v1/organizations/claude_tag/bundles/{bundle_id}/targets

Attach a Bundle to a Slack channel or a Slack workspace. A Bundle attached to a workspace can be used in the workspace and in every channel in it. Attaching a Bundle to a channel or workspace it is already attached to returns the existing Bundle Target. The channel or workspace must be set up: attaching never sets a channel up. A group direct message takes no Bundle and returns 400.

Get Bundle Target

$ ant beta:organization:claude-tag:bundles:targets retrieve

GET/v1/organizations/claude_tag/bundles/{bundle_id}/targets/{target_id}

Get one Bundle Target. Returns 404 when target_id is the identifier of another Bundle's Bundle Target, or the Bundle Target was detached.

Detach Bundle

$ ant beta:organization:claude-tag:bundles:targets delete

DELETE/v1/organizations/claude_tag/bundles/{bundle_id}/targets/{target_id}

Detach a Bundle from a Slack channel or a Slack workspace. A repeated detach returns 404.

组织

Models

组织API 密钥

组织外部密钥

组织联合颁发者

组织联合规则

组织联合规则工作区

组织邀请

组织服务账号

组织服务账号工作区

组织用户

组织工作区

组织工作区速率限制

组织工作区成员

组织工作区服务账号

组织速率限制

组织合规设置

组织分析摘要

组织分析用户

组织分析应用聊天项目

组织分析连接器

组织分析插件

组织分析技能

组织分析Artifacts

组织分析使用情况报告

组织分析用户用量报告

组织分析成本报告

组织分析用户成本报告

组织支出限额

组织支出限额生效

组织支出限额提额请求

组织RBAC 组

组织RBAC 组成员

组织RBAC 角色

组织RBAC 角色权限

组织插件

组织插件版本

组织插件安装设置

组织插件共享

组织插件市场

组织遥测目标

组织API 密钥

组织外部密钥

组织联合颁发者

组织联合规则

组织联合规则工作区

组织邀请

组织服务账号

组织服务账号工作区

组织用户

组织工作区

组织工作区速率限制

组织工作区成员

组织工作区服务账号