管理组织

Admin API

使用 Admin API 密钥或 org:admin OAuth 令牌，通过 Admin API 以编程方式管理组织成员、工作区、邀请和 API 密钥。

Admin API 不适用于个人账户。 如需与团队成员协作并添加成员，请在 Console → Settings → Organization 中设置您的组织。

Admin API 允许您以编程方式管理组织的资源，包括组织成员、工作区和 API 密钥。这为原本需要在 Claude Console 中手动配置的管理任务提供了编程控制能力。

Admin API 需要特殊访问权限

Admin API 接受两种凭证：

在 x-api-key 标头中发送的 Admin API 密钥（以 sk-ant-admin... 开头）。只有具有 admin 角色的组织成员才能创建。请参阅创建 Admin API 密钥。
在 authorization: Bearer 标头中发送的具有 org:admin 范围的 OAuth bearer 令牌。只有具有 admin、owner 或 primary owner 角色的成员才能获取。请参阅获取 OAuth bearer 令牌。

Claude Enterprise： Claude Enterprise（claude.ai）组织也使用 Admin API，但使用在 claude.ai 中创建的具有特定范围的 API 密钥。在本页的端点中，只有成员和邀请对其可用（测试版），此外还有仅限 Claude Enterprise 的端点：群组和自定义角色读取（测试版），以及支出限制。请参阅 Claude Enterprise 的用户管理。

Claude Platform on AWS： Admin API 的大部分功能在 Claude Platform on AWS 上不可用。工作区端点（/v1/organizations/workspaces 上的创建、获取、列出、更新和归档）可用。其他端点（包括组织成员、工作区成员、邀请、API 密钥、使用情况报告、成本报告和速率限制报告）不可用。详情请参阅 Claude Platform on AWS。

身份验证

使用任一凭证进行身份验证。Admin API 密钥涵盖大多数端点；服务账户、联合颁发者和联合规则端点仅接受 org:admin OAuth 令牌。以下示例以两种方式调用组织信息端点。

OAuth bearer 令牌

使用 ant CLI 在专用配置文件下登录，请求 org:admin 范围（请参阅管理员访问），然后导出 bearer 令牌。专用配置文件可防止您的日常命令以提升的访问权限运行：

CLI

ant auth login --profile admin --scope "org:admin"
export ANTHROPIC_OAUTH_TOKEN=$(ant auth print-credentials --profile admin --access-token)

交互式令牌的有效期很短；如果请求开始返回 401，请重新运行 export 命令，该命令会自动刷新令牌。

使用导出的令牌调用 Admin API：

cURL

curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

org:admin 令牌授予对整个组织的访问权限，无论底层配置文件或联合规则绑定到哪个工作区。

对于 CI 和其他非交互式工作负载，请使用 Workload Identity Federation 铸造令牌，而不是交互式登录。请参阅使用 Admin API 管理 WIF。

Admin API 密钥

要为您的组织类型创建 Admin API 密钥，请参阅创建 Admin API 密钥。

cURL

curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Admin API 的工作原理

当您使用 Admin API 时：

您使用身份验证部分中的任一凭证发出请求
API 允许您管理：
- 组织成员及其角色
- 组织成员邀请
- 工作区及其成员
- API 密钥
- 服务账户、联合颁发者和联合规则（这些端点需要 org:admin OAuth 令牌；不接受 Admin API 密钥）

这对以下场景很有用：

自动化用户入职/离职
以编程方式管理工作区访问权限
监控和管理 API 密钥使用情况

组织角色和权限

有五种组织级角色。更多详情请参阅 API Console 角色和权限文章。

角色	权限
user	可以使用 Workbench
claude_code_user	可以使用 Workbench 和 Claude Code
developer	可以使用 Workbench 并管理 API 密钥
billing	可以使用 Workbench 并管理账单详情
admin	可以执行上述所有操作，还可以管理用户

组织 owner 和 primary owner 拥有所有 admin 权限，并且还可以管理 admin。本页中所有对 admin 角色的引用也适用于 owner 和 primary owner。

关键概念

组织成员

您可以列出组织成员、更新成员角色以及移除成员。

cURL

# 列出组织成员
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# 更新成员角色
curl "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"role": "developer"}'

# 移除成员
curl --request DELETE "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

组织邀请

您可以邀请用户加入组织并管理这些邀请。

cURL

# 创建邀请
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "email": "[email protected]",
    "role": "developer"
  }'

# 列出邀请
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# 删除邀请
curl --request DELETE "https://api.anthropic.com/v1/organizations/invites/{invite_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

工作区

有关工作区的全面指南，包括 Console 和 API 示例，请参阅工作区。

工作区成员

管理用户对特定工作区的访问权限：

cURL

# 将成员添加到工作区
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "user_id": "user_xxx",
    "workspace_role": "workspace_developer"
  }'

# 列出工作区成员
curl "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# 更新成员角色
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "workspace_role": "workspace_admin"
  }'

# 从工作区移除成员
curl --request DELETE "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

API 密钥

监控和管理 API 密钥。响应中的每个密钥都包含其 expires_at 时间戳（对于没有过期时间的密钥为 null）：

cURL

# 列出 API 密钥
curl "https://api.anthropic.com/v1/organizations/api_keys?limit=10&status=active&workspace_id=wrkspc_xxx" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# 更新 API 密钥
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

服务账户

创建和管理服务账户（svac_...），即 Workload Identity Federation 令牌所代表的非人类身份。服务账户、联合颁发者或联合规则端点不接受 Admin API 密钥；请使用 org:admin OAuth 令牌。请参阅使用 Admin API 管理 WIF。

联合颁发者

联合规则

管理将颁发者令牌映射到服务账户和范围的规则（fdrl_...）。请参阅使用 Admin API 管理 WIF。

访问组织信息

使用 /v1/organizations/me 端点以编程方式获取有关您组织的信息。

例如：

cURL

curl "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

{
  "id": "12345678-1234-5678-1234-567812345678",
  "type": "organization",
  "name": "Organization Name"
}

此端点对于以编程方式确定 Admin API 密钥属于哪个组织非常有用。

有关完整的参数详情和响应模式，请参阅组织信息 API 参考。

使用情况和成本报告

使用使用情况和成本 API 跟踪您组织的使用情况和成本。

Claude Code 分析

使用 Claude Code 分析 API 监控开发者生产力和 Claude Code 的采用情况。

速率限制

使用速率限制 API 读取为您的组织及其工作区配置的速率限制。

合规 API

使用合规 API 检索您组织的审计和活动数据。Admin API 密钥只能读取活动信息流；要获得完整访问权限，请参阅设置合规 API。

最佳实践

要有效使用 Admin API：

为工作区和 API 密钥使用有意义的名称和描述
为失败的操作实现适当的错误处理
定期审计成员角色和权限
清理未使用的工作区和已过期的邀请
监控 API 密钥使用情况，审计每个密钥的 expires_at，并定期轮换密钥

常见问题

有关工作区相关的问题，请参阅工作区常见问题。

Was this page helpful?

管理组织

Admin API

使用 Admin API 密钥或 org:admin OAuth 令牌，通过 Admin API 以编程方式管理组织成员、工作区、邀请和 API 密钥。

Admin API 不适用于个人账户。 如需与团队成员协作并添加成员，请在 Console → Settings → Organization 中设置您的组织。

Admin API 需要特殊访问权限

Admin API 接受两种凭证：

在 x-api-key 标头中发送的 Admin API 密钥（以 sk-ant-admin... 开头）。只有具有 admin 角色的组织成员才能创建。请参阅创建 Admin API 密钥。
在 authorization: Bearer 标头中发送的具有 org:admin 范围的 OAuth bearer 令牌。只有具有 admin、owner 或 primary owner 角色的成员才能获取。请参阅获取 OAuth bearer 令牌。

身份验证

OAuth bearer 令牌

CLI

ant auth login --profile admin --scope "org:admin"
export ANTHROPIC_OAUTH_TOKEN=$(ant auth print-credentials --profile admin --access-token)

交互式令牌的有效期很短；如果请求开始返回 401，请重新运行 export 命令，该命令会自动刷新令牌。

使用导出的令牌调用 Admin API：

cURL

curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

org:admin 令牌授予对整个组织的访问权限，无论底层配置文件或联合规则绑定到哪个工作区。

对于 CI 和其他非交互式工作负载，请使用 Workload Identity Federation 铸造令牌，而不是交互式登录。请参阅使用 Admin API 管理 WIF。

Admin API 密钥

要为您的组织类型创建 Admin API 密钥，请参阅创建 Admin API 密钥。

cURL

curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Admin API 的工作原理

当您使用 Admin API 时：

您使用身份验证部分中的任一凭证发出请求
API 允许您管理：
- 组织成员及其角色
- 组织成员邀请
- 工作区及其成员
- API 密钥
- 服务账户、联合颁发者和联合规则（这些端点需要 org:admin OAuth 令牌；不接受 Admin API 密钥）

这对以下场景很有用：

自动化用户入职/离职
以编程方式管理工作区访问权限
监控和管理 API 密钥使用情况

组织角色和权限

有五种组织级角色。更多详情请参阅 API Console 角色和权限文章。

角色	权限
user	可以使用 Workbench
claude_code_user	可以使用 Workbench 和 Claude Code
developer	可以使用 Workbench 并管理 API 密钥
billing	可以使用 Workbench 并管理账单详情
admin	可以执行上述所有操作，还可以管理用户

组织 owner 和 primary owner 拥有所有 admin 权限，并且还可以管理 admin。本页中所有对 admin 角色的引用也适用于 owner 和 primary owner。

关键概念

组织成员

您可以列出组织成员、更新成员角色以及移除成员。

cURL

# 列出组织成员
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# 更新成员角色
curl "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"role": "developer"}'

# 移除成员
curl --request DELETE "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

组织邀请

您可以邀请用户加入组织并管理这些邀请。

cURL

# 创建邀请
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "email": "[email protected]",
    "role": "developer"
  }'

# 列出邀请
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# 删除邀请
curl --request DELETE "https://api.anthropic.com/v1/organizations/invites/{invite_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

工作区

有关工作区的全面指南，包括 Console 和 API 示例，请参阅工作区。

工作区成员

管理用户对特定工作区的访问权限：

cURL

# 将成员添加到工作区
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "user_id": "user_xxx",
    "workspace_role": "workspace_developer"
  }'

# 列出工作区成员
curl "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# 更新成员角色
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "workspace_role": "workspace_admin"
  }'

# 从工作区移除成员
curl --request DELETE "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

API 密钥

监控和管理 API 密钥。响应中的每个密钥都包含其 expires_at 时间戳（对于没有过期时间的密钥为 null）：

cURL

# 列出 API 密钥
curl "https://api.anthropic.com/v1/organizations/api_keys?limit=10&status=active&workspace_id=wrkspc_xxx" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# 更新 API 密钥
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

服务账户

联合颁发者

联合规则

管理将颁发者令牌映射到服务账户和范围的规则（fdrl_...）。请参阅使用 Admin API 管理 WIF。

访问组织信息

使用 /v1/organizations/me 端点以编程方式获取有关您组织的信息。

例如：

cURL

curl "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

{
  "id": "12345678-1234-5678-1234-567812345678",
  "type": "organization",
  "name": "Organization Name"
}

此端点对于以编程方式确定 Admin API 密钥属于哪个组织非常有用。

有关完整的参数详情和响应模式，请参阅组织信息 API 参考。

使用情况和成本报告

使用使用情况和成本 API 跟踪您组织的使用情况和成本。

Claude Code 分析

使用 Claude Code 分析 API 监控开发者生产力和 Claude Code 的采用情况。

速率限制

使用速率限制 API 读取为您的组织及其工作区配置的速率限制。

合规 API

使用合规 API 检索您组织的审计和活动数据。Admin API 密钥只能读取活动信息流；要获得完整访问权限，请参阅设置合规 API。

最佳实践

要有效使用 Admin API：

为工作区和 API 密钥使用有意义的名称和描述
为失败的操作实现适当的错误处理
定期审计成员角色和权限
清理未使用的工作区和已过期的邀请
监控 API 密钥使用情况，审计每个密钥的 expires_at，并定期轮换密钥

常见问题

有关工作区相关的问题，请参阅工作区常见问题。

Was this page helpful?

身份验证

OAuth bearer 令牌

Admin API 密钥

Admin API 的工作原理

组织角色和权限

关键概念

组织成员

组织邀请

工作区

工作区成员

API 密钥

服务账户

联合颁发者

联合规则

访问组织信息

使用情况和成本报告

Claude Code 分析

速率限制

合规 API

最佳实践

常见问题

使用 Admin API 需要哪些权限？

我可以通过 Admin API 创建新的 API 密钥吗？

移除用户时 API 密钥会发生什么？

可以通过 API 移除组织 admin 吗？

组织邀请的有效期是多久？

身份验证

OAuth bearer 令牌

Admin API 密钥

Admin API 的工作原理

组织角色和权限

关键概念

组织成员

组织邀请

工作区

工作区成员

API 密钥

服务账户

联合颁发者

联合规则

访问组织信息

使用情况和成本报告

Claude Code 分析

速率限制

合规 API

最佳实践

常见问题

使用 Admin API 需要哪些权限？

我可以通过 Admin API 创建新的 API 密钥吗？

移除用户时 API 密钥会发生什么？

可以通过 API 移除组织 admin 吗？

组织邀请的有效期是多久？

身份验证

OAuth bearer 令牌

Admin API 密钥

Admin API 的工作原理

组织角色和权限

关键概念

组织成员

组织邀请

工作区

工作区成员

API 密钥

服务账户

联合颁发者

联合规则

访问组织信息

使用情况和成本报告

Claude Code 分析

速率限制

合规 API

最佳实践

常见问题

身份验证

OAuth bearer 令牌

Admin API 密钥

Admin API 的工作原理

组织角色和权限

关键概念

组织成员

组织邀请

工作区

工作区成员

API 密钥

服务账户

联合颁发者

联合规则

访问组织信息

使用情况和成本报告

Claude Code 分析

速率限制

合规 API

最佳实践

常见问题