The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

管理者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上記すべてに加え、ユーザー管理が可能

​
主要な概念

​
組織メンバー

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

# 組織メンバーの一覧表示
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": "newuser@domain.com",
    "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キーの一覧表示
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"
  }'

​
ベストプラクティス

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

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

​
よくある質問

Was this page helpful?

エンベディング幻覚を減らす