Admin API 概览

管理

Admin 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 允许您以编程方式管理您的组织资源，包括组织成员、工作区和 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 密钥使用情况

组织角色和权限

有五个组织级别的角色。有关更多详细信息，请参阅 API Console 角色和权限文章。

角色	权限
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"

工作区

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

工作区成员

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

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 跟踪您的组织的使用情况和成本。

Claude Code 分析

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

最佳实践

要有效使用 Admin API：

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

常见问题

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

Was this page helpful?

管理

Admin 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 密钥使用情况

组织角色和权限

有五个组织级别的角色。有关更多详细信息，请参阅 API Console 角色和权限文章。

角色	权限
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"

工作区

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

工作区成员

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

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 跟踪您的组织的使用情况和成本。

Claude Code 分析

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

最佳实践

要有效使用 Admin API：

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

常见问题

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

Was this page helpful?

Admin API 如何工作

组织角色和权限

关键概念

组织成员

组织邀请

工作区

工作区成员

API 密钥

访问组织信息

使用情况和成本报告

Claude Code 分析

最佳实践

常见问题

使用 Admin API 需要什么权限？

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

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

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

组织邀请持续多长时间？

Admin API 如何工作

组织角色和权限

关键概念

组织成员

组织邀请

工作区

工作区成员

API 密钥

访问组织信息

使用情况和成本报告

Claude Code 分析

最佳实践

常见问题

使用 Admin API 需要什么权限？

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

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

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

组织邀请持续多长时间？