管理員 API 允許您以程式化方式管理組織的資源,包括組織成員、工作區和 API 金鑰。這提供了對原本需要在 Anthropic Console 中手動配置的管理任務的程式化控制。

管理員 API 需要特殊存取權限

管理員 API 需要特殊的管理員 API 金鑰(以 sk-ant-admin... 開頭),這與標準 API 金鑰不同。只有具有管理員角色的組織成員才能通過 Anthropic Console 配置管理員 API 金鑰。

管理員 API 的運作方式

當您使用管理員 API 時:

  1. 您在 x-api-key 標頭中使用管理員 API 金鑰發出請求
  2. API 允許您管理:
    • 組織成員及其角色
    • 組織成員邀請
    • 工作區及其成員
    • API 金鑰

這對以下情況很有用:

  • 自動化用戶入職/離職
  • 程式化管理工作區存取
  • 監控和管理 API 金鑰使用

組織角色和權限

有四種組織層級的角色。

角色權限
user可以使用 Workbench
developer可以使用 Workbench 和管理 API 金鑰
billing可以使用 Workbench 和管理帳單詳情
admin可以執行以上所有操作,並管理用戶

重要概念

組織成員

您可以列出組織成員、更新成員角色和移除成員。

組織邀請

您可以邀請用戶加入組織並管理這些邀請。

工作區

建立和管理工作區以組織您的資源:

工作區成員

管理用戶對特定工作區的存取:

API 金鑰

監控和管理 API 金鑰:

最佳實踐

要有效使用管理員 API:

  • 為工作區和 API 金鑰使用有意義的名稱和描述
  • 為失敗的操作實施適當的錯誤處理
  • 定期審核成員角色和權限
  • 清理未使用的工作區和過期的邀請
  • 監控 API 金鑰使用情況並定期輪換金鑰

常見問題