管理者APIを使用すると、組織のメンバー、ワークスペース、APIキーなど、組織のリソースをプログラムで管理できます。これにより、通常はAnthropic Consoleで手動設定が必要な管理タスクをプログラムで制御できます。

管理者APIには特別なアクセス権が必要です

管理者APIには、標準のAPIキーとは異なる特別な管理者APIキー(sk-ant-admin...で始まる)が必要です。管理者APIキーは、管理者ロールを持つ組織メンバーのみがAnthropic Consoleを通じて発行できます。

管理者APIの仕組み

管理者APIを使用する際:

  1. x-api-keyヘッダーに管理者APIキーを使用してリクエストを行います
  2. APIで管理できるもの:
    • 組織メンバーとそのロール
    • 組織メンバーの招待
    • ワークスペースとそのメンバー
    • APIキー

これは以下の用途に役立ちます:

  • ユーザーのオンボーディング/オフボーディングの自動化
  • ワークスペースアクセスのプログラムによる管理
  • APIキーの使用状況の監視と管理

組織のロールと権限

組織レベルのロールは4つあります。

ロール権限
userWorkbenchを使用可能
developerWorkbenchとAPIキーの管理が可能
billingWorkbenchと請求詳細の管理が可能
admin上記すべてに加え、ユーザー管理が可能

主要な概念

組織メンバー

組織メンバーの一覧表示、メンバーロールの更新、メンバーの削除が可能です。

組織の招待

ユーザーを組織に招待し、その招待を管理できます。

ワークスペース

リソースを整理するためのワークスペースの作成と管理:

ワークスペースメンバー

特定のワークスペースへのユーザーアクセスを管理します:

APIキー

APIキーの監視と管理:

ベストプラクティス

管理者APIを効果的に使用するために:

  • ワークスペースとAPIキーには意味のある名前と説明を使用する
  • 失敗した操作に対する適切なエラー処理を実装する
  • メンバーのロールと権限を定期的に監査する
  • 未使用のワークスペースと期限切れの招待をクリーンアップする
  • APIキーの使用状況を監視し、定期的にキーをローテーションする

よくある質問