Admin API 密钥可用于对本指南 Admin 部分中的每个 API 进行身份验证:Admin API、Analytics API、Compliance API、Plugins API、Claude Tag API、Spend Limits API、用量和成本分析 API、用量和成本 API 和 Rate Limits API。您无需为每个 API 单独创建密钥。唯一的例外是 Admin API 的服务账户(service-account)、联合身份颁发者(federation-issuer)和联合身份规则(federation-rule)端点,它们仅接受具有 org:admin 作用域的 OAuth bearer 令牌。请参阅获取 OAuth bearer 令牌。
在何处创建密钥取决于您的组织使用的是哪款 Claude 产品。
您需要哪种密钥?
| 您的组织 | 创建密钥的位置 | 密钥前缀 | 谁可以创建 | 适用于 |
|---|---|---|---|---|
Claude Console(Claude Platform,platform.claude.com) |
Claude Console 中的 Admin keys 页面(platform.claude.com/settings/admin-keys) |
sk-ant-admin01-... |
具有 admin 角色的组织成员 | Admin API、用量和成本分析 API、用量和成本 API、Rate Limits API、Claude Code Analytics API,以及 Compliance API 的 Activity Feed |
Claude Enterprise(claude.ai) |
claude.ai > Organization settings > API | sk-ant-api01-... |
父组织的主要所有者(primary owner)(所有关联组织)。组织所有者(organization owner)可以创建仅携带 Compliance API 作用域、且仅限于其自身组织的密钥 | 用户管理(Admin API 的成员、邀请和群组端点)、Plugins API、Claude Tag API、Compliance API、Claude Enterprise Analytics API、用量和成本分析 API 以及 Spend Limits API,具体取决于您选择的作用域 |
在一个组织中创建的密钥不能用于管理另一个组织。如果您的公司同时使用 Claude Console 和 Claude Enterprise,请在每个组织中各创建一个密钥。
为 Claude Console 组织创建密钥
-
以组织管理员身份登录
只有具有 admin 角色的组织成员才能创建 Admin API 密钥。请参阅组织角色和权限。
-
打开 Admin keys 设置
在 Claude Console 中,前往 Admin keys 页面(
platform.claude.com/settings/admin-keys)。 -
创建密钥
点击 Create admin key,为其命名,选择密钥过期时间,然后点击 Add。Claude Console 密钥没有可选择的作用域;每个密钥都对所有接受 Admin API 密钥的端点拥有完全访问权限(本页顶部提到的服务账户和联合身份端点不接受 Admin API 密钥)。
-
复制并存储密钥
复制显示的密钥(以
sk-ant-admin01-开头)并将其存储在您的密钥管理器中。完整密钥仅显示一次。
为 Claude Enterprise 组织创建密钥
-
以主要所有者或组织所有者身份登录
Claude Enterprise 父组织的主要所有者可以创建能够访问每个关联组织的密钥,或仅限于单个组织的密钥。组织所有者可以创建仅具有 Compliance API 作用域、且仅限于其自身组织的密钥。
-
打开 API 设置
前往 claude.ai > Organization settings > API 并找到 Keys 部分。
-
点击 + Create key
为密钥命名,并从作用域表中选择您需要的作用域。主要所有者可以在单个密钥上组合来自不同 API 的作用域(例如
read:analytics和read:spend_limits)。 -
复制并存储密钥
复制显示的密钥(以
sk-ant-api01-开头)并将其存储在您的密钥管理器中。完整密钥仅显示一次。
为 Claude Enterprise 密钥选择作用域
创建 Claude Enterprise 密钥时,请选择您计划调用的 API 所需的每个作用域(scope)。作用域在创建时即固定;若要稍后添加作用域,请创建新密钥。
| 要调用…… | 选择这些作用域 |
|---|---|
| Admin API 用户管理:列出和查找成员及邀请;读取自定义角色及其权限 | read:members |
Admin API 用户管理:更改成员角色、移除成员、创建和撤回邀请(如需在角色变更或邀请中分配 managed 角色,还需选择 write:rbac_groups) |
write:members |
| Admin API 用户管理:读取群组及其成员 | read:rbac_groups |
Admin API 用户管理:创建、重命名和删除群组;添加和移除群组成员;与 write:members 一起使用时,可分配 managed 角色(在邀请或角色变更中)或在邀请中分配群组 |
write:rbac_groups |
| Plugins API:读取插件、版本、安装设置、共享和市场;下载插件文件,包括成员个人插件的文件;在连接市场之前对其进行验证 | read:plugins |
Plugins API:上传插件和版本;选择向成员提供哪个版本;删除插件,包括成员的个人插件;设置和移除安装设置;设置市场的默认安装设置;在连接市场之前对其进行验证(如需读取插件,还需选择 read:plugins) |
write:plugins |
| Claude Tag API:读取 Claude Tag 在 Slack 频道、Slack 工作区上的设置以及 Slack 默认设置;列出 Access bundle 及其附加位置(没有其他作用域可以授予对 Claude Tag API 的访问权限) | read:claude_tag |
Claude Tag API:设置和移除频道;更改设置;附加和分离 Access bundle(如需同时读取,还需选择 read:claude_tag) |
write:claude_tag |
| Spend Limits API:读取成员的有效支出限额和提额请求 | read:spend_limits |
| Spend Limits API:设置或清除每用户支出限额;批准或拒绝提额请求 | write:spend_limits |
| Claude Enterprise Analytics API:参与度、采用率、成本和使用情况报告;用量和成本分析 API:令牌用量和成本报告 | read:analytics |
| Compliance API Activity Feed:组织范围的活动事件 | read:compliance_activities |
| Compliance API 聊天、文件和项目端点以及 Compliance API 会话端点:读取聊天、文件、项目、会话记录和组织用户 | read:compliance_user_data |
| Compliance API 聊天、文件和项目端点:删除聊天、文件和项目 | delete:compliance_user_data |
| Compliance API 组织端点:读取组织元数据和有效设置 | read:compliance_org_data |
| Admin API 用户管理读取端点以及每个 Compliance API 读取端点,使用单一只读作用域(用于安全审计集成;不包括 Spend Limits 或 Analytics API) | read:org_audit |
必须先为您的组织启用 Compliance 和 Analytics API,才能使用具有这些作用域的密钥。请参阅设置 Compliance API 和获取 Claude Enterprise Analytics API 的访问权限。
只有当您的组织可以使用 Plugins API 时,您才能创建和使用带有 read:plugins 或 write:plugins 的密钥。Plugins API 指南说明了哪些组织可以使用它。在这些组织中,带有 read:org_audit 或 read:compliance_org_data 的密钥也可以调用 Plugins API 的读取端点(包括文件下载),但不能进行市场验证。read:plugins 和 write:plugins 作用域仅作用于创建该密钥的组织。请参阅 Plugins API 作用域和读取同一父组织下的其他组织。
使用密钥
在每个请求的 x-api-key 标头中传递密钥。有关完整的请求示例,请参阅各 API 的文档。
超出密钥作用域的调用会返回 403 Forbidden,并附带一条消息,列出该密钥拥有的作用域以及该端点所需的作用域。
后续步骤
-
Admin API:管理组织成员、工作区和 API 密钥。
-
Spend Limits API:为您的 Claude Enterprise 组织设置每成员支出限额并审核提额请求。
-
Analytics API:报告 Claude Code 生产力或 Claude Enterprise 参与度和采用率。
-
Compliance API:审计活动并检索或删除整个组织中的用户内容。