Ikhtisar Admin 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 programatis, termasuk anggota organisasi, workspace, dan kunci API. Ini menyediakan kontrol programatis 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
Ketika 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
- Workspace dan anggota mereka
- Kunci API
Ini berguna untuk:
- Mengotomatisasi onboarding/offboarding pengguna
- Mengelola akses workspace secara programatis
- Memantau dan mengelola penggunaan kunci API
Peran dan izin organisasi
Ada lima peran tingkat organisasi. Lihat detail lebih lanjut di sini.
| 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.
# 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": "[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"Workspace
Buat dan kelola workspace (console) untuk mengorganisir 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"
}'Mengakses informasi organisasi
Dapatkan informasi tentang organisasi Anda secara programatis 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 programatis organisasi mana yang dimiliki oleh kunci Admin API.
Untuk detail parameter lengkap dan skema respons, lihat referensi API Informasi Organisasi.
Mengakses laporan penggunaan dan biaya
Untuk mengakses laporan penggunaan dan biaya untuk organisasi Anda, gunakan endpoint API Penggunaan dan Biaya:
- Endpoint Penggunaan (
/v1/organizations/usage_report/messages) menyediakan data penggunaan terperinci, termasuk jumlah token dan metrik permintaan, dikelompokkan berdasarkan berbagai dimensi seperti workspace, pengguna, dan model. - Endpoint Biaya (
/v1/organizations/cost_report) menyediakan data biaya yang terkait dengan penggunaan organisasi Anda, memungkinkan Anda melacak pengeluaran dan mengalokasikan biaya berdasarkan workspace atau deskripsi.
Endpoint ini memberikan wawasan terperinci tentang penggunaan organisasi Anda dan biaya terkait.
Mengakses analitik Claude Code
Untuk organisasi yang menggunakan Claude Code, API Analitik Claude Code menyediakan metrik produktivitas terperinci dan wawasan penggunaan:
- Endpoint Analitik Claude Code (
/v1/organizations/usage_report/claude_code) menyediakan metrik agregat harian untuk penggunaan Claude Code, termasuk sesi, baris kode, commit, pull request, statistik penggunaan alat, dan data biaya yang dipecah berdasarkan pengguna dan model.
API ini memungkinkan Anda melacak produktivitas pengembang, menganalisis adopsi Claude Code, dan membangun dashboard kustom untuk organisasi Anda.
Praktik terbaik
Untuk menggunakan Admin API secara efektif:
- Gunakan nama dan deskripsi yang bermakna untuk workspace dan kunci API
- Implementasikan penanganan kesalahan yang tepat untuk operasi yang gagal
- Audit peran dan izin anggota secara berkala
- Bersihkan workspace yang tidak digunakan dan undangan yang kedaluwarsa
- Pantau penggunaan kunci API dan rotasi kunci secara berkala