管理和監控
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 如何運作
當您使用 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"組織邀請
組織邀請
您可以邀請使用者加入組織並管理這些邀請。
# 建立邀請
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"工作區
工作區
# 建立工作區
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"工作區成員
工作區成員
管理使用者對特定工作區的存取：
# 將成員新增至工作區
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 金鑰
監控和管理 API 金鑰：
# 列出 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 的組織，Claude Code Analytics API 提供詳細的生產力指標和使用情況洞察：
- Claude Code Analytics 端點（
/v1/organizations/usage_report/claude_code）提供 Claude Code 使用情況的每日聚合指標，包括會話、程式碼行數、提交、拉取請求、工具使用統計資料，以及按使用者和模型細分的成本資料。
此 API 讓您能夠追蹤開發人員生產力、分析 Claude Code 採用情況，並為您的組織建立自訂儀表板。
最佳實務
最佳實務
要有效使用 Admin API：
- 為工作區和 API 金鑰使用有意義的名稱和描述
- 為失敗的操作實作適當的錯誤處理
- 定期稽核成員角色和權限
- 清理未使用的工作區和過期的邀請
- 監控 API 金鑰使用情況並定期輪換金鑰
常見問題
常見問題