管理和监控

Admin API 概述

The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

Admin API 允许您以编程方式管理组织的资源，包括组织成员、工作空间和 API 密钥。这提供了对管理任务的编程控制，否则这些任务需要在 Claude Console 中进行手动配置。

Admin API 需要特殊访问权限

Admin API 需要特殊的 Admin API 密钥（以 sk-ant-admin... 开头），这与标准 API 密钥不同。只有具有管理员角色的组织成员才能通过 Claude Console 提供 Admin API 密钥。

Admin API 的工作原理

当您使用 Admin API 时：

您在 x-api-key 标头中使用您的 Admin API 密钥发出请求
API 允许您管理：
- 组织成员及其角色
- 组织成员邀请
- 工作空间及其成员
- API 密钥

这对以下用途很有用：

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

组织角色和权限

有五个组织级别的角色。查看更多详细信息这里。

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

关键概念

组织成员

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

Shell

# 列出组织成员
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 "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"

组织邀请

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

Shell

# 创建邀请
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --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"

工作空间

创建和管理工作空间 (控制台) 来组织您的资源：

Shell

# 创建工作空间
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"name": "Production"}'

# 列出工作空间
curl "https://api.anthropic.com/v1/organizations/workspaces?limit=10&include_archived=false" \
  --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}/archive" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

工作空间成员

管理用户对特定工作空间的访问：

Shell

# 将成员添加到工作空间
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
  --header "anthropic-version: 2023-06-01" \
  --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 "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 密钥：

Shell

# 列出 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 "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

访问组织信息

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

例如：

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

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

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

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

访问使用情况和成本报告

要访问您组织的使用情况和成本报告，请使用使用情况和成本 API 端点：

使用情况端点 (/v1/organizations/usage_report/messages) 提供详细的使用数据，包括令牌计数和请求指标，按工作空间、用户和模型等各种维度分组。
成本端点 (/v1/organizations/cost_report) 提供与您组织使用情况相关的成本数据，允许您跟踪费用并按工作空间或描述分配成本。

这些端点提供了对您组织使用情况和相关成本的详细洞察。

访问 Claude Code 分析

对于使用 Claude Code 的组织，Claude Code Analytics API 提供详细的生产力指标和使用洞察：

Claude Code Analytics 端点 (/v1/organizations/usage_report/claude_code) 提供 Claude Code 使用情况的每日聚合指标，包括会话、代码行数、提交、拉取请求、工具使用统计和按用户和模型细分的成本数据。

此 API 使您能够跟踪开发人员生产力、分析 Claude Code 采用情况，并为您的组织构建自定义仪表板。

最佳实践

要有效使用 Admin API：

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

常见问题

管理和监控

Admin API 概述

The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

Admin API 需要特殊访问权限

Admin API 的工作原理

当您使用 Admin API 时：

您在 x-api-key 标头中使用您的 Admin API 密钥发出请求
API 允许您管理：
- 组织成员及其角色
- 组织成员邀请
- 工作空间及其成员
- API 密钥

这对以下用途很有用：

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

组织角色和权限

有五个组织级别的角色。查看更多详细信息这里。

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

关键概念

组织成员

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

Shell

# 列出组织成员
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 "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"

组织邀请

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

Shell

# 创建邀请
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --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"

工作空间

创建和管理工作空间 (控制台) 来组织您的资源：

Shell

# 创建工作空间
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"name": "Production"}'

# 列出工作空间
curl "https://api.anthropic.com/v1/organizations/workspaces?limit=10&include_archived=false" \
  --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}/archive" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

工作空间成员

管理用户对特定工作空间的访问：

Shell

# 将成员添加到工作空间
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
  --header "anthropic-version: 2023-06-01" \
  --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 "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 密钥：

Shell

# 列出 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 "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

访问组织信息

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

例如：

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

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

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

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

访问使用情况和成本报告

要访问您组织的使用情况和成本报告，请使用使用情况和成本 API 端点：

使用情况端点 (/v1/organizations/usage_report/messages) 提供详细的使用数据，包括令牌计数和请求指标，按工作空间、用户和模型等各种维度分组。
成本端点 (/v1/organizations/cost_report) 提供与您组织使用情况相关的成本数据，允许您跟踪费用并按工作空间或描述分配成本。

这些端点提供了对您组织使用情况和相关成本的详细洞察。

访问 Claude Code 分析

对于使用 Claude Code 的组织，Claude Code Analytics API 提供详细的生产力指标和使用洞察：

Claude Code Analytics 端点 (/v1/organizations/usage_report/claude_code) 提供 Claude Code 使用情况的每日聚合指标，包括会话、代码行数、提交、拉取请求、工具使用统计和按用户和模型细分的成本数据。

此 API 使您能够跟踪开发人员生产力、分析 Claude Code 采用情况，并为您的组织构建自定义仪表板。

最佳实践

要有效使用 Admin API：

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

Admin API 的工作原理

组织角色和权限

关键概念

组织成员

组织邀请

工作空间

工作空间成员

API 密钥

访问组织信息

访问使用情况和成本报告

访问 Claude Code 分析

最佳实践

常见问题

使用 Admin API 需要什么权限？

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

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

可以通过 API 移除组织管理员吗？

组织邀请持续多长时间？

工作空间有限制吗？

什么是默认工作空间？

组织角色如何影响工作空间访问？

可以在工作空间中分配哪些角色？

可以更改组织管理员或账单成员的工作空间角色吗？

当组织角色发生变化时，工作空间访问会发生什么？

Admin API 的工作原理

组织角色和权限

关键概念

组织成员

组织邀请

工作空间

工作空间成员

API 密钥

访问组织信息

访问使用情况和成本报告

访问 Claude Code 分析

最佳实践

常见问题

使用 Admin API 需要什么权限？

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

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

可以通过 API 移除组织管理员吗？

组织邀请持续多长时间？

工作空间有限制吗？

什么是默认工作空间？

组织角色如何影响工作空间访问？

可以在工作空间中分配哪些角色？

可以更改组织管理员或账单成员的工作空间角色吗？

当组织角色发生变化时，工作空间访问会发生什么？