Menyiapkan Compliance API

Compliance API menggunakan dua jenis kunci, dan kunci mana yang Anda buat bergantung pada produk Claude yang digunakan organisasi Anda. Primary owner dan organization owner membuat Compliance Access Key di claude.ai; kunci ini membuka akses ke seluruh Compliance API. Kunci milik primary owner dapat mencakup setiap organisasi di bawah organisasi induk; kunci milik organization owner hanya mencakup organisasi mereka sendiri. Organization admin membuat kunci Admin API di Claude Console; kunci ini hanya membuka akses ke Activity Feed.



Kunci mana yang Anda butuhkan?

Tenant Claude Enterprise memiliki satu organisasi induk yang memusatkan identitas, SSO, dan SCIM untuk setiap organisasi beban kerja di bawahnya. Organisasi beban kerja ini adalah organisasi tertaut dari induk tersebut.



Menyiapkan Compliance API

Penyiapan adalah satu alur: aktifkan Compliance API untuk organisasi Anda, lalu buat Compliance Access Key di claude.ai. Organisasi Claude Console sebagai gantinya membuat kunci Admin API setelah pengaktifan; kunci Admin API hanya menjangkau Activity Feed.



Membuat kunci Admin API

Ikuti langkah-langkah di Membuat kunci Admin API, lalu tetapkan kunci sebagai variabel lingkungan:

export ANTHROPIC_ADMIN_KEY=sk-ant-admin01-...

Nama variabel yang berbeda mencegah kunci Admin API menimpa Compliance Access Key jika Anda menyediakan keduanya. Contoh cURL dalam panduan ini membaca kunci dari $ANTHROPIC_COMPLIANCE_ACCESS_KEY; ganti dengan $ANTHROPIC_ADMIN_KEY saat memanggil Activity Feed dengan kunci Admin API.

Kunci Admin API membawa cakupan read:compliance_activities hanya jika Compliance API telah diaktifkan untuk organisasi pada saat kunci dibuat; lihat Menyiapkan Compliance API. Kunci ini tidak dapat diberikan cakupan Compliance API lainnya, sehingga panggilan ke endpoint apa pun selain Activity Feed mengembalikan 403 Forbidden.

Untuk peran kunci yang sama dalam mengelola organisasi Claude Console Anda, lihat Admin API.



Memeriksa cakupan kunci Anda

Untuk memeriksa cakupan pada kunci yang sudah Anda miliki, gunakan salah satu sinyal berikut.

• Prefiks kunci. sk-ant-admin01- adalah kunci Admin API (hanya membawa read:compliance_activities, tergantung pada waktu pengaktifan di bagian sebelumnya). sk-ant-api01- adalah Compliance Access Key; cakupannya adalah subset yang Anda pilih saat pembuatan.
• UI Pengaturan. Buka bagian Keys di claude.ai > Organization settings > API, atau bagian Admin keys di Claude Console > Settings > Admin keys, dan baca kolom Scopes untuk kunci tersebut.
• Respons error. Panggilan yang melebihi cakupan kunci mengembalikan 403 dengan pesan dalam format Missing required scopes. Got: [<scopes the key carries>] Needed: [<scopes the endpoint requires>]. Lihat Menangani error Compliance API untuk katalog error lengkap.

{
  "error": {
    "type": "permission_error",
    "message": "Missing required scopes. Got: ['read:compliance_activities'] Needed: ['read:compliance_user_data']"
  }
}



Mengelola dan merotasi kunci

Hapus Compliance Access Key dari tabel Keys yang sama tempat Anda membuatnya: buka claude.ai > Organization settings > API. Hapus kunci Admin API dari Claude Console > Settings > Admin keys.

Penghapusan kunci berlaku pada permintaan berikutnya: tidak ada masa tenggang. Compliance Access Key tidak kedaluwarsa dengan sendirinya.

Untuk merotasi kunci tanpa gangguan layanan:

1. Buat kunci baru dengan cakupan yang sama.
2. Perbarui integrasi Anda untuk menggunakan kunci baru.
3. Verifikasi bahwa integrasi berhasil dengan kunci baru.
4. Hapus kunci lama.

Kursor paginasi yang disimpan sebelum rotasi tetap valid: kursor dicakupkan ke organisasi, bukan ke kunci.

Jika Compliance Access Key bocor, hapus segera, audit Activity Feed untuk aktivitas compliance_api_accessed oleh kunci yang disusupi, dan rotasi kredensial hilir apa pun yang dapat dijangkau oleh kunci yang bocor. Berikan activity_types[]=compliance_api_accessed untuk membatasi cakupan kueri, lalu di klien Anda, pertahankan aktivitas yang actor.type-nya adalah api_actor dan actor.api_key_id-nya cocok dengan kunci yang disusupi; lihat Memahami objek Activity untuk skema actor.



Langkah berikutnya