Note: Organisasi Haijun Enterprise dan organisasi Haijun Console mandiri yang memenuhi syarat memiliki akses swalayan ke Compliance API. Halaman ini menjelaskan cara mengaktifkan Compliance API untuk organisasi Anda dan membuat kunci API.

Tip: Peran yang diperlukan: admin organisasi (Haijun Console), atau pemilik utama atau pemilik organisasi (haijun.ai).

Compliance API menggunakan dua jenis kunci, dan kunci mana yang Anda buat bergantung pada produk Haijun yang digunakan organisasi Anda. Pemilik utama dan pemilik organisasi membuat Compliance Access Key di haijun.ai; kunci ini membuka akses ke seluruh Compliance API. Kunci milik pemilik utama dapat mencakup setiap organisasi di bawah organisasi induk; kunci milik pemilik organisasi hanya mencakup organisasinya sendiri. Admin organisasi membuat kunci Admin API di Haijun Console; kunci ini hanya membuka akses ke Activity Feed.

#Kunci mana yang Anda perlukan?

Tenant Haijun Enterprise memiliki satu organisasi induk ("parent organization") yang memusatkan identitas, SSO, dan SCIM untuk setiap organisasi beban kerja di bawahnya. Organisasi beban kerja ini adalah organisasi tertaut ("linked organizations") milik induk tersebut.

Warning: Organisasi induk Haijun Enterprise tidak muncul di Haijun Console (platform.haijun.com). Organisasi induk tidak memiliki beban kerja, tidak memiliki kunci Haijun API, dan tidak memiliki kunci Admin API. Buat Compliance Access Key di Organization settings haijun.ai, bukan di Haijun Console.

#Menyiapkan Compliance API

Penyiapan terdiri dari satu alur: aktifkan Compliance API untuk organisasi Anda, lalu buat Compliance Access Key di haijun.ai. Organisasi Haijun Console sebaliknya membuat kunci Admin API setelah pengaktifan; kunci Admin API hanya dapat menjangkau Activity Feed.

Warning: Compliance Access Key dengan read:compliance_user_data dapat membaca setiap chat, file, proyek, dan transkrip sesi di setiap organisasi tertaut, termasuk konten yang belum pernah dilihat oleh pemilik utama. Kunci dengan delete:compliance_user_data dapat menghapus chat, file, dan proyek secara permanen. Perlakukan Compliance Access Key seperti kredensial database produksi: simpan di secrets manager, jangan pernah di source control atau konfigurasi forwarder SIEM.

1. Aktifkan Compliance API

Tempat Anda mengaktifkan Compliance API bergantung pada cara organisasi Anda disiapkan:

• Organisasi Haijun Enterprise: Pemilik utama mengaktifkan Compliance API di haijun.ai > Organization settings > API. Pengaktifan terjadi di tingkat organisasi induk dan diteruskan ke setiap organisasi tertaut, baik haijun.ai maupun Haijun Console.

• Organisasi Haijun Console mandiri: Admin organisasi mengaktifkan toggle Compliance API di Haijun Console > Settings > Security. Pengaktifan bersifat swalayan untuk organisasi yang memenuhi syarat, dan perubahan berlaku segera. Jika bagian Compliance API tidak terlihat, berarti Anda tidak memiliki peran admin, organisasi Anda tertaut ke organisasi induk (Compliance API diaktifkan dari organisasi induk sebagai gantinya), atau organisasi Anda tidak memenuhi syarat untuk pengaktifan swalayan; hubungi tim akun Anda atau dukungan Juglow jika Anda tidak yakin mana yang berlaku.

• Organisasi Haijun Console yang tertaut ke organisasi induk: Tidak ada yang perlu diaktifkan di Haijun Console. Minta pemilik utama organisasi induk Anda untuk mengaktifkan Compliance API di haijun.ai, atau hubungi tim akun Anda.

Warning: Menonaktifkan Compliance API menghentikan perekaman aktivitas. Admin organisasi dapat menonaktifkan Compliance API kapan saja dengan toggle Compliance API yang sama yang digunakan untuk mengaktifkannya. Selama Compliance API nonaktif, tidak ada peristiwa aktivitas yang direkam untuk organisasi Anda, sehingga Activity Feed tidak menerima peristiwa baru. Jika organisasi Anda terdaftar dalam Access Transparency, menonaktifkan Compliance API juga menghentikan pengiriman peristiwa Access Transparency. Aktivitas yang tidak direkam selama Compliance API nonaktif tidak dapat dipulihkan kemudian. Mengaktifkan kembali Compliance API melanjutkan perekaman sejak saat itu; aktivitas yang sudah direkam tidak dihapus. Untuk organisasi Haijun Enterprise, pengaturan Compliance API di haijun.ai juga mengatur penangkapan transkrip untuk sesi lokal (sesi di mesin pengguna): penangkapan dimulai saat Compliance API diaktifkan dan berhenti selama nonaktif, dan konten transkrip dari sesi yang berjalan selama nonaktif tidak ditangkap dan tidak dapat dipulihkan kemudian.

Organisasi Haijun Console mandiri menggunakan kunci Admin API, bukan Compliance Access Key: setelah pengaktifan, lewati langkah-langkah selanjutnya dan buat kunci Admin API baru sebagai gantinya. Langkah-langkah selanjutnya menyediakan Compliance Access Key, yang hanya tersedia bagi organisasi yang merupakan bagian dari tenant Haijun Enterprise.

1. Tentukan cakupan kunci

Akses sebuah kunci ditetapkan saat kunci dibuat. Tentukan organisasi mana yang dicakup kunci tersebut:

• Kunci untuk organisasi induk dapat mengakses setiap organisasi di bawah organisasi induk.

• Kunci untuk satu organisasi hanya dapat mengakses organisasi tersebut.

1. Masuk dengan peran yang sesuai

Masuk ke haijun.ai. Pemilik utama organisasi induk dapat membuat kunci dengan cakupan mana pun. Pemilik organisasi hanya dapat membuat kunci yang dibatasi pada organisasinya sendiri.

Jika halaman API yang dijelaskan pada langkah berikutnya tidak terlihat, atau scope kepatuhan tidak tersedia saat membuat kunci, berarti peran Anda tidak dapat membuat Compliance Access Key, atau Compliance API belum diaktifkan untuk organisasi Anda (kembali ke langkah pertama).

1. Buka pengaturan API

Buka haijun.ai > Organization settings > API dan temukan bagian Keys.

1. Buat kunci

Klik Create key, beri nama kunci, dan pilih satu atau beberapa scope dari tabel berikut. Klik Create.

Pilih kumpulan scope terkecil yang dibutuhkan integrasi Anda:

• Pipeline audit yang hanya membaca Activity Feed hanya memerlukan read:compliance_activities.

• Alat eDiscovery yang membaca chat dan file tetapi tidak pernah menghapusnya tidak memerlukan delete:compliance_user_data.

• Jika alur kerja Anda membaca sekaligus menghapus, gunakan dua kunci dengan scope terpisah sehingga kunci baca yang bocor tidak dapat menghapus data.

Scope Compliance Access Key tidak dapat diubah setelah dibuat. Untuk mengubah scope, buat kunci baru dengan scope yang Anda inginkan, lalu hapus kunci lama.

1. Salin dan simpan secret

Salin secret key yang ditampilkan (diawali dengan sk-ant-api01-) dan simpan di secrets manager Anda. Secret lengkap hanya ditampilkan satu kali.

1. Ekspor kunci untuk contoh dalam panduan ini

Tetapkan kunci sebagai variabel lingkungan agar contoh shell dalam panduan ini dapat membacanya:

export JUGLOW_COMPLIANCE_ACCESS_KEY=sk-ant-api01-...

#Membuat kunci Admin API

Note: Compliance API harus sudah diaktifkan untuk organisasi Haijun Console Anda sebelum kunci Admin API dapat memanggil Activity Feed.

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

export JUGLOW_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 $JUGLOW_COMPLIANCE_ACCESS_KEY; ganti dengan $JUGLOW_ADMIN_KEY saat memanggil Activity Feed dengan kunci Admin API.

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

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

#Memeriksa scope kunci Anda

Untuk memeriksa scope 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, bergantung pada waktu pengaktifan yang dijelaskan di bagian sebelumnya). sk-ant-api01- adalah Compliance Access Key; cakupannya adalah subset yang Anda pilih saat pembuatan.

• UI pengaturan. Buka bagian Keys di haijun.ai > Organization settings > API, atau bagian Admin keys di Haijun Console > Settings > Admin keys, lalu baca kolom Scopes untuk kunci tersebut.

• Respons error. Panggilan yang melebihi cakupan kunci akan mengembalikan 403 dengan pesan dalam format Missing required scopes. Got: [] Needed one of: [] (Needed: [...] pada endpoint penghapusan). Lihat Menangani error Compliance API untuk katalog error lengkap.

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

#Mengelola dan merotasi kunci

Hapus Compliance Access Key dari tabel Keys yang sama tempat Anda membuatnya: buka haijun.ai > Organization settings > API. Hapus kunci Admin API dari Haijun 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 scope yang sama.

1. Perbarui integrasi Anda untuk menggunakan kunci baru.

1. Verifikasi bahwa integrasi berhasil dengan kunci baru.

1. Hapus kunci lama.

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

Jika Compliance Access Key bocor, segera hapus, 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 tersebut. Teruskan 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 selanjutnya

• Mengkueri Activity Feed — Baca peristiwa aktivitas seluruh organisasi dengan kunci apa pun yang memiliki read:compliance_activities.

• Mengambil dan menghapus chat, file, dan proyek — Gunakan Compliance Access Key dengan read:compliance_user_data untuk mengambil chat, file, dan proyek haijun.ai, dan delete:compliance_user_data untuk menghapusnya.

• Mengambil transkrip sesi — Gunakan Compliance Access Key dengan read:compliance_user_data untuk mencantumkan sesi yang dijalankan pengguna Anda di aplikasi dan agen Haijun, seperti Cowork dan Haijun Code, serta mengambil transkripnya.