Claude Platform Docs
管理组织

Admin API

使用 Admin API 以编程方式管理组织成员、工作区、邀请和 API 密钥,可使用 Admin API 密钥、org:admin OAuth 令牌,或个人密钥或服务账户密钥进行身份验证。

Admin API 让您能够以编程方式管理组织的成员、工作区、邀请和 API 密钥,而无需在 Claude Console 中手动操作。

身份验证

使用三种凭证中的任意一种进行身份验证。Admin API 密钥涵盖大多数端点。服务账户、联合身份颁发者和联合规则端点仅接受 org:admin OAuth 令牌。个人密钥或服务账户密钥与 Admin API 密钥一样,通过 x-api-key 标头发送。以下示例分别使用 OAuth 令牌和 Admin API 密钥调用组织信息端点。

Python、TypeScript、C#、Go、Java、PHP 和 Ruby SDK 在 client.organization 下公开本页中的端点,ant CLI 则在 ant organization 下公开这些端点。本页中的示例使用默认客户端,该客户端从 ANTHROPIC_API_KEY 读取 Admin API 密钥,或从 ANTHROPIC_AUTH_TOKEN 读取 OAuth bearer 令牌。Python、TypeScript、C#、Go 和 Java 中的 SDK 列表方法返回一个按需获取更多页面的迭代器,因此 limit 设置的是每页大小,而不是总数。PHP、Ruby 和 curl 示例返回一页。在 CLI 中,--limit 限制成员、邀请、工作区、工作区成员和 API 密钥列表的结果数量。有关每个端点的参数和响应,请参阅 Admin API 参考。

OAuth bearer 令牌

使用 ant CLI 在具有 org:admin 作用域的专用配置文件下登录(请参阅管理员访问),然后导出 bearer 令牌。--profile admin 会将 org:admin 凭证存储在其自己的配置文件下,并将其设为 CLI 的活动配置文件。导出的变量适用于该 shell 中的每个 SDK 和 CLI 调用。请使用专门用于管理的 shell,完成后取消设置该变量,并使用 ant profile activate default 将 CLI 切换回去:

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

交互式令牌的有效期很短。如果请求开始返回 401,请重新运行 export 命令以刷新令牌。

SDK 和 ant CLI 会自动读取 ANTHROPIC_AUTH_TOKEN。请在同一 shell 中保持 ANTHROPIC_API_KEY 未设置,以便它们发送 bearer 令牌。自动化工作负载可跳过登录:它们通过工作负载身份联合进行身份验证,SDK 和 CLI 会根据联合环境变量执行令牌交换。请参阅引导工作负载以管理 WIF。

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

client = anthropic.Anthropic()

organization = client.organization.retrieve()

print(f"id: {organization.id}")
print(f"name: {organization.name}")

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

对于 CI 和其他非交互式工作负载,请使用工作负载身份联合(Workload Identity Federation)签发令牌,而不是交互式登录。请参阅使用 Admin API 管理 WIF。

Admin API 密钥

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

client = anthropic.Anthropic()

organization