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 memungkinkan Anda mengelola sumber daya organisasi Anda secara terprogram, termasuk anggota organisasi, workspace, dan kunci API. Ini memberikan kontrol terprogram atas tugas administratif yang biasanya memerlukan konfigurasi manual di Anthropic Console.

Admin API memerlukan akses khusus

Admin API memerlukan kunci API Admin khusus (dimulai dengan sk-ant-admin...) yang berbeda dari kunci API standar. Hanya anggota organisasi dengan peran admin yang dapat menyediakan kunci Admin API melalui Anthropic Console.

Cara kerja Admin API

Ketika Anda menggunakan Admin API:

  1. Anda membuat permintaan menggunakan kunci Admin API Anda di header x-api-key
  2. API memungkinkan Anda mengelola:
    • Anggota organisasi dan peran mereka
    • Undangan anggota organisasi
    • Workspace dan anggotanya
    • Kunci API

Ini berguna untuk:

  • Mengotomatisasi onboarding/offboarding pengguna
  • Mengelola akses workspace secara terprogram
  • Memantau dan mengelola penggunaan kunci API

Peran dan izin organisasi

Ada lima peran tingkat organisasi.

PeranIzin
userDapat menggunakan Workbench
claude_code_userDapat menggunakan Workbench dan Claude Code
developerDapat menggunakan Workbench dan mengelola kunci API
billingDapat menggunakan Workbench dan mengelola detail penagihan
adminDapat melakukan semua hal di atas, plus mengelola pengguna

Konsep utama

Anggota Organisasi

Anda dapat mencantumkan anggota organisasi, memperbarui peran anggota, dan menghapus anggota.

# Daftar anggota organisasi
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Perbarui peran anggota
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"}'

# Hapus anggota
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"

Undangan Organisasi

Anda dapat mengundang pengguna ke organisasi dan mengelola undangan tersebut.

# Buat undangan
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"
  }'

# Daftar undangan
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Hapus undangan
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"

Workspace

Buat dan kelola workspace untuk mengatur sumber daya Anda:

# Buat workspace
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"}'

# Daftar workspace
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"

# Arsipkan workspace
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"

Anggota Workspace

Kelola akses pengguna ke workspace tertentu:

# Tambahkan anggota ke workspace
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"
  }'

# Daftar anggota workspace
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"

# Perbarui peran anggota
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"
  }'

# Hapus anggota dari workspace
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"

Kunci API

Pantau dan kelola kunci API:

# Daftar kunci 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"

# Perbarui kunci 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"
  }'

Praktik terbaik

Untuk menggunakan Admin API secara efektif:

  • Gunakan nama dan deskripsi yang bermakna untuk workspace dan kunci API
  • Terapkan penanganan kesalahan yang tepat untuk operasi yang gagal
  • Audit peran dan izin anggota secara teratur
  • Bersihkan workspace yang tidak digunakan dan undangan yang kedaluwarsa
  • Pantau penggunaan kunci API dan rotasi kunci secara berkala

FAQ