Lompat ke konten

Kunci API

API kunci diatur pada tingkat organisasi dengan kontrol akses berdasarkan peran (RBAC). Setiap kunci dapat diberikan peran organisasi yang luas dan peran aplikasi opsional, memberikan Anda kontrol yang halus atas apa yang dapat diakses oleh setiap kunci.

Navigasikan ke Pengaturan > Organisasi > API Kunci di console.capgo.app/settings/organization/api-keys.

Halaman menampilkan dua bagian:

  • Kunci RBAC — Kunci dengan peran yang ditugaskan (direkomendasikan). Kunci ini menggunakan sistem izin berbasis peran baru.
  • Kunci Legacy — Kunci lama yang menggunakan sistem mode sederhanaread, upload, write, allTidak ada pengaturan peran.
API keys halaman daftar menampilkan RBAC dan Legacy bagian.

Bagaimana cara membuat kunci API baru?

Judul bagian “Bagaimana cara membuat kunci API baru?”
  1. Klik tombol ”+” di atas tabel kunci RBAC.

  2. Isi informasi Kunci:

    • Nama (wajib) — Label deskriptif untuk kunci (misalnya “Deploy CI/CD”, “Monitoring Baca-Saja”).
    • Buat kunci aman (opsional) — Ketika dicentang, kunci akan dihash server-side. Kunci teks biasa ditampilkan hanya sekali setelah pembuatan. Anda tidak akan dapat mengambilnya lagi.
    • Atur tanggal kadaluarsa (opsional) — Pilih tanggal setelah mana kunci akan berhenti berfungsi. Beberapa organisasi mewajibkan tanggal kadaluarsa secara paksa melalui kebijakan.
API formulir pembuatan kunci dengan nama, opsi kunci aman, dan tanggal kadaluarsa
  1. Pilih Peran Organisasi — Ini menentukan izin dasar kunci di seluruh organisasi. Peran yang tersedia (tergantung pada tingkat peran Anda):

    • Tidak Ada — Tidak ada akses organisasi; kunci hanya memiliki akses ke aplikasi yang ditugaskan secara individu.
    • Anggota — Akses baca dasar ke organisasi.
    • Admin — Akses administratif penuh ke organisasi (mewarisi akses ke semua aplikasi).
  2. Jika peran org yang dipilih bukan Admin, Anda dapat menambahkan akses per aplikasi:

    • Klik ”+ Add App” untuk membuka pemilih aplikasi.
    • Pilih satu atau lebih aplikasi, kemudian tentukan peran untuk setiap:
      • Pembaca Aplikasi — Akses baca-saja ke aplikasi.
      • Uploader Aplikasi — Dapat mengunggah bundle baru.
      • Pengembang Aplikasi — Dapat mengelola konfigurasi dan penginstalan aplikasi.
      • Admin Aplikasi — Akses penuh ke aplikasi.
Pemilihan peran RBAC dengan peran organisasi dan per aplikasi
  1. Klik “Create”.

  2. If you checked “Create secure key”, a modal will display the plain-text key. Jika Anda memeriksa "Tampilkan kunci aman", akan muncul modal dengan kunci teks. Salin segera

One-time API key secret modal with copy button

Modal kunci rahasia API sekali pakai dengan tombol salin

Bagaimana cara mengelola (mengedit) sebuah API kunci?

Klik ikon wrench Pada kunci RBAC apa pun di daftar. Ini membuka halaman detail kunci di mana Anda dapat:

  • Mengubah nama kunci Mengupdate peran organisasi.
  • Menambahkan, menghapus, atau mengubah peran aplikasi Klik.
  • “Simpan Perubahan” Pada kunci RBAC apa pun di daftar..

Mengubah kunci Mengubah kunci ketika selesai.

API kunci edit halaman dengan pengaturan peran saat ini

Bagaimana cara menghasilkan kembali kunci API?

Bagian berjudul “Bagaimana cara menghasilkan kembali kunci API?”

Untuk menghasilkan nilai rahasia kunci API, klik ikon refresh (Regenerate) pada kunci apa pun di daftar.

Dialog konfirmasi akan muncul. Setelah mengkonfirmasi:

  • Untuk kunci yang aman (dihash): Kunci teks biasa baru dihasilkan dan ditampilkan sekali di modal. Salinlah segera.
  • Untuk kunci utama: Nilai kunci di-regenerasi secara server-side.

Apapun integrasi menggunakan nilai kunci lama akan berhenti berfungsi segera.

Konfirmasi regenerasi kunci API

Klik ikon sampah (Hapus) pada kunci mana pun di daftar. Konfirmasi penghapusan di dialog.

Kunci di-revokasi segera — apapun permintaan menggunakan kunci tersebut akan gagal.

Konfirmasi dialog penghapusan kunci API

Jika Anda melihat kunci di Kunci Legacy bagian (kunci tanpa penugasan peran), kunci ini menggunakan sistem izin berbasis mode yang lebih tua (read, upload, write, all). Mereka masih berfungsi, tetapi tidak mendapatkan manfaat dari RBAC izin yang lebih halus.

Kunci legacy dapat diregenerasi dan dihapus dari daftar, tetapi tidak dapat diedit untuk menambahkan peran RBAC. Kami merekomendasikan membuat kunci RBAC baru dan menghapus kunci legacy ketika memungkinkan.

Jika Anda perlu mengelola kunci legacy secara langsung, Anda masih dapat mengaksesnya di console.capgo.app/dashboard/apikeysHalaman Edit