# Admin API

---

<Tip>
**Admin API 不适用于个人账户。** 要与团队成员协作和添加成员，请在**控制台 → 设置 → 组织**中设置您的组织。
</Tip>

[Admin API](/docs/en/api/admin) 允许您以编程方式管理组织的资源，包括组织成员、工作区和 API 密钥。这提供了对管理任务的编程控制，否则需要在 [Claude 控制台](/)中手动配置。

<Check>
  **Admin API 需要特殊访问权限**

  Admin API 需要一个特殊的 Admin API 密钥（以 `sk-ant-admin...` 开头），它与标准 API 密钥不同。只有具有管理员角色的组织成员才能通过 Claude 控制台配置 Admin API 密钥。
</Check>

<Note>
**Claude Platform on AWS：** 大部分 Admin API 在 Claude Platform on AWS 上不可用。工作区端点（`/v1/organizations/workspaces` 上的创建、获取、列表、更新和归档）可用。其他端点包括组织成员、工作区成员、邀请、API 密钥、使用报告、成本报告和速率限制报告不可用。有关详细信息，请参阅 [Claude Platform on AWS](/docs/en/build-with-claude/claude-platform-on-aws)。
</Note>

## Admin API 如何工作

当您使用 Admin API 时：

1. 您使用 `x-api-key` 头中的 Admin API 密钥发出请求
2. API 允许您管理：
   - 组织成员及其角色
   - 组织成员邀请
   - 工作区及其成员
   - API 密钥

这对于以下场景很有用：
- 自动化用户入职/离职
- 以编程方式管理工作区访问
- 监控和管理 API 密钥使用

## 组织角色和权限

有五个组织级别的角色。有关更多详细信息，请参阅 [API 控制台角色和权限](https://support.claude.com/en/articles/10186004-api-console-roles-and-permissions)文章。

| 角色 | 权限 |
|------|------|
| user | 可以使用工作台 |
| claude_code_user | 可以使用工作台和 [Claude Code](https://code.claude.com/docs/en/overview) |
| developer | 可以使用工作台和管理 API 密钥 |
| billing | 可以使用工作台和管理计费详情 |
| admin | 可以执行以上所有操作，外加管理用户 |

## 核心概念

### 组织成员

您可以列出[组织成员](/docs/en/api/admin-api/users/get-user)、更新成员角色和移除成员。

<CodeGroup>
```bash 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"
```

</CodeGroup>

### 组织邀请

您可以邀请用户加入组织并管理这些[邀请](/docs/en/api/admin-api/invites/get-invite)。

<CodeGroup>

```bash 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": "newuser@domain.com",
    "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"
```

</CodeGroup>

### 工作区

有关工作区的全面指南，包括控制台和 API 示例，请参阅[工作区](/docs/en/manage-claude/workspaces)。

### 工作区成员

管理[用户对特定工作区的访问](/docs/en/api/admin-api/workspace_members/get-workspace-member)：

<CodeGroup>

```bash 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"
```

</CodeGroup>

### API 密钥

监控和管理 [API 密钥](/docs/en/api/admin-api/apikeys/get-api-key)：

<CodeGroup>

```bash 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"
  }'
```

</CodeGroup>

## 访问组织信息

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

例如：

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

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

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

有关完整的参数详细信息和响应架构，请参阅[组织信息 API 参考](/docs/en/api/admin-api/organization/get-me)。

## 使用量和成本报告

使用[使用量和成本 API](/docs/en/manage-claude/usage-cost-api) 跟踪您组织的使用量和成本。

## Claude Code 分析

使用 [Claude Code 分析 API](/docs/en/manage-claude/claude-code-analytics-api) 监控开发者生产力和 Claude Code 采用率。

## 速率限制

使用[速率限制 API](/docs/en/manage-claude/rate-limits-api) 读取为您的组织及其工作区配置的速率限制。

## Compliance API

使用 [Compliance API](/docs/en/manage-claude/compliance-api) 检索您组织的审计和活动数据。Admin API 密钥只能读取活动订阅源；有关完全访问权限，请参阅[获取 Compliance API 访问权限](/docs/en/manage-claude/compliance-api-access)。

## 最佳实践

要有效使用 Admin API：

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

## 常见问题

<section title="使用 Admin API 需要什么权限？">

只有具有管理员角色的组织成员才能使用 Admin API。他们还必须拥有特殊的 Admin API 密钥（以 `sk-ant-admin` 开头）。

</section>

<section title="我可以通过 Admin API 创建新的 API 密钥吗？">

不可以，出于安全原因，新的 API 密钥只能通过 Claude 控制台创建。Admin API 只能管理现有的 API 密钥。

</section>

<section title="移除用户时 API 密钥会怎样？">

API 密钥保持其当前状态，因为它们限定在组织，而不是单个用户。

</section>

<section title="组织管理员可以通过 API 移除吗？">

不可以，出于安全原因，具有管理员角色的组织成员无法通过 API 移除。

</section>

<section title="组织邀请持续多长时间？">

组织邀请在 21 天后过期。目前无法修改此过期期限。

</section>

有关工作区特定的问题，请参阅[工作区常见问题](/docs/en/manage-claude/workspaces#faq)。