Ikhtisar Admin API

AdminAdministrasi

Ikhtisar Admin API

Kelola sumber daya organisasi Anda secara terprogram dengan Admin API, termasuk anggota organisasi, ruang kerja, dan kunci 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 memungkinkan Anda mengelola sumber daya organisasi secara terprogram, termasuk anggota organisasi, ruang kerja, dan kunci API. Ini memberikan kontrol terprogram atas tugas administratif yang sebaliknya memerlukan konfigurasi manual di Claude Console.

Admin API memerlukan akses khusus

Admin API memerlukan kunci Admin API 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 Claude Console.

Cara kerja Admin API

Saat Anda menggunakan Admin API:

Anda membuat permintaan menggunakan kunci Admin API Anda di header x-api-key
API memungkinkan Anda mengelola:
- Anggota organisasi dan peran mereka
- Undangan anggota organisasi
- Ruang kerja dan anggota mereka
- Kunci API

Ini berguna untuk:

Mengotomatisasi onboarding/offboarding pengguna
Mengelola akses ruang kerja secara terprogram
Memantau dan mengelola penggunaan kunci API

Peran dan izin organisasi

Ada lima peran tingkat organisasi. Lihat detail lebih lanjut di artikel peran dan izin API Console.

Peran	Izin
user	Dapat menggunakan Workbench
claude_code_user	Dapat menggunakan Workbench dan Claude Code
developer	Dapat menggunakan Workbench dan mengelola kunci API
billing	Dapat menggunakan Workbench dan mengelola detail penagihan
admin	Dapat melakukan semua hal di atas, plus mengelola pengguna

Konsep kunci

Anggota Organisasi

Anda dapat membuat daftar anggota organisasi, memperbarui peran anggota, dan menghapus anggota.

Shell

# 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.

Shell

# 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": "[email protected]",
    "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"

Ruang Kerja

Untuk panduan komprehensif tentang ruang kerja, termasuk contoh Console dan API, lihat Ruang Kerja.

Anggota Ruang Kerja

Kelola akses pengguna ke ruang kerja tertentu:

Shell

# Tambahkan anggota ke ruang kerja
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 ruang kerja
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 ruang kerja
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:

Shell

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

Mengakses informasi organisasi

Dapatkan informasi tentang organisasi Anda secara terprogram dengan endpoint /v1/organizations/me.

Sebagai contoh:

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"
}

Endpoint ini berguna untuk menentukan secara terprogram organisasi mana yang dimiliki kunci Admin API.

Untuk detail parameter lengkap dan skema respons, lihat referensi API Informasi Organisasi.

Laporan penggunaan dan biaya

Lacak penggunaan dan biaya organisasi Anda dengan Usage and Cost API.

Analitik Claude Code

Pantau produktivitas pengembang dan adopsi Claude Code dengan Claude Code Analytics API.

Praktik terbaik

Untuk menggunakan Admin API secara efektif:

Gunakan nama dan deskripsi yang bermakna untuk ruang kerja dan kunci API
Implementasikan penanganan kesalahan yang tepat untuk operasi yang gagal
Audit peran dan izin anggota secara teratur
Bersihkan ruang kerja yang tidak digunakan dan undangan yang kedaluwarsa
Pantau penggunaan kunci API dan putar kunci secara berkala

FAQ

Untuk pertanyaan khusus ruang kerja, lihat FAQ Ruang Kerja.

Was this page helpful?

AdminAdministrasi

Ikhtisar Admin API

Kelola sumber daya organisasi Anda secara terprogram dengan Admin API, termasuk anggota organisasi, ruang kerja, dan kunci 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 memerlukan akses khusus

Cara kerja Admin API

Saat Anda menggunakan Admin API:

Anda membuat permintaan menggunakan kunci Admin API Anda di header x-api-key
API memungkinkan Anda mengelola:
- Anggota organisasi dan peran mereka
- Undangan anggota organisasi
- Ruang kerja dan anggota mereka
- Kunci API

Ini berguna untuk:

Mengotomatisasi onboarding/offboarding pengguna
Mengelola akses ruang kerja secara terprogram
Memantau dan mengelola penggunaan kunci API

Peran dan izin organisasi

Ada lima peran tingkat organisasi. Lihat detail lebih lanjut di artikel peran dan izin API Console.

Peran	Izin
user	Dapat menggunakan Workbench
claude_code_user	Dapat menggunakan Workbench dan Claude Code
developer	Dapat menggunakan Workbench dan mengelola kunci API
billing	Dapat menggunakan Workbench dan mengelola detail penagihan
admin	Dapat melakukan semua hal di atas, plus mengelola pengguna

Konsep kunci

Anggota Organisasi

Anda dapat membuat daftar anggota organisasi, memperbarui peran anggota, dan menghapus anggota.

Shell

# 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.

Shell

# 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": "[email protected]",
    "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"

Ruang Kerja

Untuk panduan komprehensif tentang ruang kerja, termasuk contoh Console dan API, lihat Ruang Kerja.

Anggota Ruang Kerja

Kelola akses pengguna ke ruang kerja tertentu:

Shell

# Tambahkan anggota ke ruang kerja
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 ruang kerja
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 ruang kerja
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:

Shell

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

Mengakses informasi organisasi

Dapatkan informasi tentang organisasi Anda secara terprogram dengan endpoint /v1/organizations/me.

Sebagai contoh:

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"
}

Endpoint ini berguna untuk menentukan secara terprogram organisasi mana yang dimiliki kunci Admin API.

Untuk detail parameter lengkap dan skema respons, lihat referensi API Informasi Organisasi.

Laporan penggunaan dan biaya

Lacak penggunaan dan biaya organisasi Anda dengan Usage and Cost API.

Analitik Claude Code

Pantau produktivitas pengembang dan adopsi Claude Code dengan Claude Code Analytics API.

Praktik terbaik

Untuk menggunakan Admin API secara efektif:

Gunakan nama dan deskripsi yang bermakna untuk ruang kerja dan kunci API
Implementasikan penanganan kesalahan yang tepat untuk operasi yang gagal
Audit peran dan izin anggota secara teratur
Bersihkan ruang kerja yang tidak digunakan dan undangan yang kedaluwarsa
Pantau penggunaan kunci API dan putar kunci secara berkala

FAQ

Untuk pertanyaan khusus ruang kerja, lihat FAQ Ruang Kerja.

Was this page helpful?

Cara kerja Admin API

Peran dan izin organisasi

Konsep kunci

Anggota Organisasi

Undangan Organisasi

Ruang Kerja

Anggota Ruang Kerja

Kunci API

Mengakses informasi organisasi

Laporan penggunaan dan biaya

Analitik Claude Code

Praktik terbaik

FAQ

Izin apa yang diperlukan untuk menggunakan Admin API?

Bisakah saya membuat kunci API baru melalui Admin API?

Apa yang terjadi pada kunci API saat menghapus pengguna?

Bisakah admin organisasi dihapus melalui API?

Berapa lama undangan organisasi berlaku?

Cara kerja Admin API

Peran dan izin organisasi

Konsep kunci

Anggota Organisasi

Undangan Organisasi

Ruang Kerja

Anggota Ruang Kerja

Kunci API

Mengakses informasi organisasi

Laporan penggunaan dan biaya

Analitik Claude Code

Praktik terbaik

FAQ

Izin apa yang diperlukan untuk menggunakan Admin API?

Bisakah saya membuat kunci API baru melalui Admin API?

Apa yang terjadi pada kunci API saat menghapus pengguna?

Bisakah admin organisasi dihapus melalui API?

Berapa lama undangan organisasi berlaku?