Referensi Pengendalian Akses
Copy sebuah prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.
Capgo menggunakan pengaturan akses berdasarkan peran (RBAC) untuk mengelola apa yang dapat dilakukan oleh setiap anggota tim. Peran-peran diatur berdasarkan ruang lingkup — dari organisasi keseluruhan hingga bundle tunggal.
Untuk melihat panduan visual mengelola anggota di dashboard, lihat Organisasi.
Ruangan peran
Bagian berjudul “Ruangan peran”Setiap peran termasuk dalam ruang lingkup yang menentukan sumber daya apa yang memberikan akses.
| Ruang Lingkup | context: Halaman/area: Bantuan / halaman bantuan premium atau bagian bantuan halaman footer. Peran: Judul bagian atau halaman. Dilihat di: halaman support-policy.astro. Kunci pesan `support_policy_scope_title` (Judul Ruang Lingkup Bantuan). | Contoh penggunaan kasus |
|---|---|---|
| Organisasi | Seluruh organisasi dan semua aplikasinya | Kolaborator Anda mendapatkan Super Admin; akuntan Anda mendapatkan Billing Manager |
| Aplikasi | Aplikasi tunggal dan saluran-salurannya | Seseorang yang bekerja sebagai pengembang aplikasi pada satu aplikasi mendapatkan App Developer |
| Saluran | Saluran tunggal dalam aplikasi | Seseorang yang hanya mengelola saluran staging Paket |
| __CAPGO_KEEP_0__ | A versi bundel tunggal | Seorang reviewer memerlukan akses baca ke satu rilis tertentu |
Seorang anggota dapat menjabat suatu peran per lingkungan target — misalnya, satu peran organisasi, satu peran di Aplikasi A, dan peran yang berbeda di Aplikasi B.
Peran Organisasi
Judul bagian “Peran Organisasi”Peran-peran ini diberikan ketika mengundang anggota. Mereka memberikan akses di seluruh organisasi.
| Peran | Nama Internal | Deskripsi |
|---|---|---|
| Super Admin | org_super_admin | Setara Pemilik. Pengontrolan penuh termasuk menghapus organisasi, mengelola tagihan, dan mentransfer aplikasi. Otomatis diberikan kepada pembuat organisasi. |
| Pengelola | org_admin | Pengelolaan penuh — mengelola anggota, aplikasi, saluran. Tidak dapat menghapus organisasi, mengupdate tagihan, mentransfer aplikasi, atau mempromosikan pengguna menjadi Super Pengelola. |
| Pengelola Tagihan | org_billing_admin | Akses tagihan saja: melihat dan mengupdate informasi tagihan, faktur, dan log audit tagihan. Tidak ada akses ke aplikasi atau anggota. |
| Anggota | org_member | Akses baca-saja ke organisasi dan semua aplikasinya. |
Matris Izin Organisasi
Bab berjudul “Matris Izin Organisasi”| Izin | Deskripsi | Pengelola Utama | Admin | Manajer Billing | Anggota |
|---|---|---|---|---|---|
org.read | Lihat organisasi | ✅ | ✅ | ✅ | ✅ |
org.update_settings | Ubah nama organisasi, logo, alamat email pengelola | ✅ | ✅ | ❌ | ❌ |
org.delete | Hapus organisasi secara permanen | ✅ | ❌ | ❌ | ❌ |
org.read_members | Lihat daftar anggota | ✅ | ✅ | ❌ | ✅ |
org.invite_user | Undang anggota baru | ✅ | ✅ | ❌ | ❌ |
org.update_user_roles | Ubah peran anggota (Admin tidak dapat mempromosikan ke Super Admin — diblokir oleh hierarki peran) | ✅ | ✅ | ❌ | ❌ |
org.read_billing | Lihat informasi billing dan paket saat ini | ✅ | ✅ | ✅ | ❌ |
org.update_billing | Ubah metode pembayaran dan paket | ✅ | ❌ | ✅ | ❌ |
org.read_invoices | Lihat faktur | ✅ | ✅ | ✅ | ❌ |
org.read_audit | View log aktivitas organisasi | ✅ | ✅ | ❌ | ❌ |
org.read_billing_audit | View log audit billing khusus | ✅ | ✅ | ✅ | ❌ |
Peran aplikasi
Judul Bagian: Peran AplikasiTerbatas pada satu aplikasi. Gunakan peran ini ketika anggota tim hanya boleh bekerja pada satu aplikasi, bukan seluruh organisasi.
| Peran | Nama Internal | Deskripsi |
|---|---|---|
| Pengelola Aplikasi | app_admin | Penuh kontrol atas satu aplikasi — saluran, perangkat, peran pengguna untuk aplikasi. Tidak dapat menghapus atau mentransfer aplikasi (operasi tersebut adalah tingkat organisasi). |
| Pengembang Aplikasi | app_developer | Muat bundle, kelola perangkat, trigger build native, ubah pengaturan saluran. Tidak dapat menghapus, tidak dapat mengubah pengaturan aplikasi, tidak dapat membuat saluran. |
| Pemuat Aplikasi | app_uploader | Akses baca + muat versi bundle baru. |
| Pembaca Aplikasi | app_reader | Akses baca saja — statistik, paket, saluran, log, perangkat. |
| Pratinjau Aplikasi | app_preview | Pratinjau CI berdasarkan organisasi dan aplikasi: unggah paket dan buat saluran pratinjau. Pembuatan saluran tersebut secara otomatis memberikan hak siklus hidup hanya untuk saluran tersebut. |
Matris Izin Aplikasi
Matris Izin Aplikasi| Izin | Deskripsi | Admin Aplikasi | Pengembang Aplikasi | Pengunggah Aplikasi | Pembaca Aplikasi |
|---|---|---|---|---|---|
app.read | Lihat detail aplikasi, statistik, dan metadata | ✅ | ✅ | ✅ | ✅ |
app.update_settings | Ubah pengaturan aplikasi | ✅ | ❌ | ❌ | ❌ |
app.read_bundles | Lihat daftar bundle yang diunggah | ✅ | ✅ | ✅ | ✅ |
app.upload_bundle | Unggah versi bundle baru | ✅ | ✅ | ✅ | ❌ |
app.create_channel | Buat saluran baru | ✅ | ❌ | ❌ | ❌ |
app.read_channels | Lihat saluran | ✅ | ✅ | ✅ | ✅ |
app.read_logs | Lihat log pengiriman update | ✅ | ✅ | ✅ | ✅ |
app.manage_devices | Tetapkan, menggantikan, atau melepas perangkat | ✅ | ✅ | ❌ | ❌ |
app.read_devices | Lihat daftar perangkat | ✅ | ✅ | ✅ | ✅ |
app.build_native | Aktifkan bangun awan asli | ✅ | ✅ | ❌ | ❌ |
app.read_audit | Lihat log aktivitas aplikasi | ✅ | ✅ | ✅ | ✅ |
app.update_user_roles | Kelola penugasan peran aplikasi yang berlaku | ✅ | ❌ | ❌ | ❌ |
bundle.delete | Hapus bundle | ✅ | ❌ | ❌ | ❌ |
yang dapat melakukan mereka, terlepas dari peran aplikasi.
Set Ijin Tampilan AplikasiJudul bagian “Set Ijin Tampilan Aplikasi” Pilih (app_previewTampilan Aplikasi (App Preview) untuk sebuah kunci CI yang terkait dengan organisasi dan aplikasi, yang mengelola siklus pratinjau PR tanpa akses luas aplikasi atau organisasi.
Mengikat app_preview Hanya memberikan izin aplikasi ini:
| Izin | Mengizinkan |
|---|---|
app.read | Membaca aplikasi yang dipilih |
app.read_bundles | Membaca bundle yang diunggah |
app.upload_bundle | Mengunggah bundle |
app.create_channel | Membuat saluran |
When an App Preview key creates a channel, Capgo automatically gives that key a child channel_preview Izin
| Mengizinkan | Membuat saluran |
|---|---|
channel.read | Baca saluran yang dibuat oleh kunci |
channel.promote_bundle | Setel bundle yang diunggah sendiri oleh kunci tersebut pada saluran tersebut |
channel.delete | Hapus saluran tersebut |
Karena app_preview menyimpan app.read, kunci tersebut mungkin menampilkan metadata saluran dalam aplikasi yang dipilih. Batasan otomatis anak adalah pengelolaan batas: tidak memberikan mutasi siklus untuk saluran yang tidak dibuat oleh kunci tersebut.
Capgo merekam kunci pratinjau yang membuat setiap saluran dan mengunggah setiap bundle. Oleh karena itu, kunci Pratinjau Aplikasi dapat membuat setiap saluran pratinjau non-umum yang diperlukan, mempromosikan bundle sendiri, dan menghapus saluran dan bundle secara atomik dengan channel delete --delete-bundle; tidak dapat melakukan hal itu pada saluran default/main yang ada, saluran kunci pratinjau lain, atau bundle kunci lain.
Tidak termasuk app.update_settings, pengelolaan perangkat atau peran channel.update_settings, channel.rollback_bundlePengaturan perangkat paksa, manajemen perangkat, atau umum bundle.delete.
Peran saluran
Judul bagian “Peran saluran”Disediakan untuk saluran perangkat lunak tunggal. Berguna untuk memberikan akses yang spesifik ke saluran rilis tertentu.
| Peran | Nama internal | Deskripsi |
|---|---|---|
| Pengelola Channel | channel_admin | Penuh kontrol atas satu channel: pengaturan, promosikan/rollback bundle, mengelola perangkat paksa. |
| Penglihat Channel | channel_reader | Akses baca saja — bundle saat ini, riwayat, perangkat paksa, log audit. |
| Penglihatan Channel | channel_preview | Dibuat secara otomatis oleh kunci App Preview yang membuat channel tersebut: baca, promosikan bundle sendiri, dan hapus channel tersebut. |
Matris Izin Saluran
Judul Bagian “Matris Izin Saluran”| Izin | Deskripsi | Pengelola Saluran | Penglihat Saluran | Penglihatan Saluran |
|---|---|---|---|---|
channel.read | Lihat saluran dan paket aktifnya saat ini | ✅ | ✅ | ✅ |
channel.update_settings | Ubah pengaturan saluran (toggle platform, kebijakan update…) | ✅ | ❌ | ❌ |
channel.delete | Hapus saluran | ✅ | ❌ | ✅ |
channel.read_history | Lihat riwayat pengaturan paket | ✅ | ✅ | ❌ |
channel.promote_bundle | Set paket aktif pada saluran | ✅ | ❌ | ✅ |
channel.rollback_bundle | Kembali ke bundle sebelumnya | ✅ | ❌ | ❌ |
channel.manage_forced_devices | Forcekan perangkat tertentu ke saluran ini | ✅ | ❌ | ❌ |
channel.read_forced_devices | Tampilkan daftar perangkat yang dipaksa | ✅ | ✅ | ❌ |
channel.read_audit | Tampilkan log aktivitas saluran | ✅ | ✅ | ❌ |
Peran bundle
Judul: Peran bundleTerbatas pada versi bundle tunggal. Jarang dibutuhkan — kebanyakan tim menggunakan peran aplikasi daripada ini.
| Peran | Nama internal | Deskripsi |
|---|---|---|
| Pengelola Paket | bundle_admin | Baca, ubah metadata, dan hapus paket tertentu. |
| Penglihat Paket | bundle_reader | Akses baca-saja ke paket tertentu. |
Otorisasi saluran (Dashboard)
Bab berjudul “Otorisasi saluran (Dashboard)”Pada dashboard, akses saluran ditentukan oleh peran aplikasi pengguna secara default. Untuk kontrol yang lebih halus, Anda dapat mengatur otorisasi saluran tertentu per pengguna atau kelompok tanpa mengubah peran aplikasi mereka.
Konfigurasi penggantian dilakukan dari aplikasi’s Akses tab dengan mengklik tombol izin saluran (ikon pelindung) di samping pengguna. Lihat Organisasi — Menggantikan izin saluran untuk walkthrough visual.
Pengaturan yang dapat diubah
Bab berjudul “Pengaturan yang dapat diubah”| Izin | Deskripsi | Kebiasaan default |
|---|---|---|
| Baca | Lihat saluran dan paket terkini | Diteruskan dari peran aplikasi |
| Riwayat | Lihat riwayat pengaturan bundle | Diteruskan dari peran aplikasi |
| Hubungkan bundle | Atur atau ubah bundle aktif di saluran | Diteruskan dari peran aplikasi |
Setiap izin dapat diatur menjadi:
- Default — mewarisi dari peran aplikasi (default)
- Izinkan — secara eksplisit berikan, tanpa memperhatikan peran aplikasi
- Menghalangi — secara eksplisit blokir, terlepas dari peran aplikasi
Ini memungkinkan Anda, misalnya, memberikan pembaca aplikasi kemampuan untuk menghubungkan paket di saluran tanpa mempromosikannya ke pengembang aplikasi. staging Struktur Hiertarki
Judul bagian ‘Struktur Hiertarki’
Peran membentuk hierarki. Peran indukmengambil semua izin anaknya. Ini berarti bahwa bisa melakukan apa saja yang bisa dilakukan oleh org_admin bisa melakukan apa saja yang bisa dilakukan oleh app_admin bisa melakukan apa saja yang bisa dilakukan oleh channel_admin dan seterusnya.
Super Admin (org_super_admin) └── Admin (org_admin) └── App Admin (app_admin) ├── App Developer (app_developer) │ └── App Uploader (app_uploader) │ └── App Reader (app_reader) ├── Bundle Admin (bundle_admin) │ └── Bundle Viewer (bundle_reader) └── Channel Admin (channel_admin) └── Channel Viewer (channel_reader)Bagaimana cara kerjanya dalam prakteknya:
- Seorang Admin Organisasi di tingkat organisasi dapat melakukan semua yang dapat dilakukan oleh seorang Admin Aplikasi pada setiap aplikasi di organisasi.
- Seorang Admin Aplikasi pada aplikasi tertentu dapat melakukan semua yang dapat dilakukan oleh seorang Admin Saluran pada setiap saluran di aplikasi tersebut.
- Seorang Pengembang Aplikasi bisa melakukan semua yang bisa dilakukan seorang Pengunggah Aplikasi , plus lebih lagi.
Hirarki hanya mengalir ke bawah — tidak pernah mendapatkan izin organisasi-level, bahkan jika mereka juga menjabat sebagai peran aplikasi-level. channel_admin Grup
Judul bagian “Grup”
Alih-alih mengasignkan peran kepada setiap pengguna secara individu, Anda dapat membuat__CAPGO_KEEP_0__ kelompok dan tambahkan peran ke kelompok tersebut. Setiap anggota kelompok akan mewarisi peran-peran tersebut secara otomatis.
Bagaimana kelompok bekerja
Judul bagian “Bagaimana kelompok bekerja”- Kelompok milik suatu organisasi – tidak dapat menjangkau beberapa org.
- Kelompok dapat menyimpan pengikat peran pada apapun ruang lingkup: org, aplikasi, saluran, atau paket. Misalnya, sebuah kelompok dapat diberikan peran App Developer pada Aplikasi A dan peran Pengaturan Saluran peran di saluran App B.
stagingKetika hak akses pengguna dievaluasi, semua keanggotaan grup mereka diresolusi secara transparan. Jika salah satu grup mereka memberikan hak akses yang diperlukan, akses diizinkan. - Pengguna dapat menjadi anggota
- beberapa grup , dan hak akses dari semua grup bersifat aditif.Hak akses berbasis grup hanya berlaku untuk
- prinsipal pengguna — kunci __CAPGO_KEEP_0__ tidak mengwarisi peran grup. — API keys do not inherit group roles.
Bagian berjudul “Kapan menggunakan grup”
Ketika hak akses pengguna dievaluasi, semua keanggotaan grup mereka diresolusi secara transparan. Jika salah satu grup mereka memberikan hak akses yang diperlukan, akses diizinkan.| Skenario | Tanpa kelompok | Dengan kelompok |
|---|---|---|
| 5 insinyur QA memerlukan akses Developer ke 3 aplikasi | 15 pengikat peran individu | 1 kelompok + 3 pengikat peran |
| Seseorang bergabung dengan tim QA | Tambahkan 3 pengikat peran secara manual | Tambahkan mereka ke kelompok |
| Seseorang meninggalkan tim QA | Hapus 3 pengikat peran secara manual | Hapus mereka dari kelompok |
Mengelola grup melalui API
Judul bagian “Mengelola grup melalui API”Semua endpoint grup memerlukan autentikasi dan disajikan di bawah /private/groups.
Daftar grup
Judul bagian “Daftar grup”curl -X GET "https://api.capgo.app/private/groups/<ORG_ID>" \ -H "authorization: <API_KEY>"Memerlukan org.read_members izin.
Buat grup
Judul bagian “Buat grup”curl -X POST "https://api.capgo.app/private/groups/<ORG_ID>" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "name": "QA Team", "description": "Quality assurance engineers" }'Memerlukan org.update_user_roles izin (Super Admin atau Kopi ke clipboard).
Update kelompok
Bagian berjudul “Update kelompok”curl -X PUT "https://api.capgo.app/private/groups/<GROUP_ID>" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "name": "QA Team", "description": "Updated description" }'Hapus kelompok
Bagian berjudul “Hapus kelompok”curl -X DELETE "https://api.capgo.app/private/groups/<GROUP_ID>" \ -H "authorization: <API_KEY>"Menghapus sebuah kelompok juga menghapus semua ikatannya. Anggota tidak dihapus dari organisasi.
Daftar anggota kelompok
Bagian berjudul “Daftar anggota kelompok”curl -X GET "https://api.capgo.app/private/groups/<GROUP_ID>/members" \ -H "authorization: <API_KEY>"Menambahkan anggota ke kelompok
Bagian berjudul “Menambahkan anggota ke kelompok”curl -X POST "https://api.capgo.app/private/groups/<GROUP_ID>/members" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "user_id": "<USER_UUID>" }'Pengguna harus sudah menjadi anggota organisasi. Menambahkan anggota yang sudah ada adalah tidak ada tindakan.
Menghapus anggota dari kelompok
Judul Bagian “Menghapus anggota dari kelompok”curl -X DELETE "https://api.capgo.app/private/groups/<GROUP_ID>/members/<USER_UUID>" \ -H "authorization: <API_KEY>"Menggunakan API untuk menetapkan peran
Judul Bagian “Menggunakan API untuk menetapkan peran”Daftar anggota
Judul bagian: "Daftar anggota"curl -X GET "https://api.capgo.app/organization/members" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "orgId": "<ORG_ID>" }'Respons:
[ { "uid": "user-uuid", "email": "alice@example.com", "image_url": "https://...", "role": "org_admin", "is_tmp": false }]Undang anggota
Judul bagian: "Undang anggota"curl -X POST "https://api.capgo.app/organization/members" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "orgId": "<ORG_ID>", "email": "bob@example.com", "invite_type": "org_admin" }'Nilai yang diterima invite_type:
| Nilai | Peran yang diberikan |
|---|---|
org_super_admin | Admin Utama |
org_admin | Admin |
org_billing_admin | Pengelola Tagihan |
org_member | Anggota |
Hapus anggota
Judul Bagian “Hapus anggota”curl -X DELETE "https://api.capgo.app/organization/members" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "orgId": "<ORG_ID>", "email": "bob@example.com" }'Mengasignasikan peran melalui CLI
Judul Bagian “Mengasignasikan peran melalui CLI”Daftar Organisasi
Judul Bagian “Daftar Organisasi”npx @capgo/cli organization list --apikey <API_KEY>Daftar anggota
Bab berjudul “Daftar anggota”npx @capgo/cli organization members <ORG_ID> --apikey <API_KEY>Peran khusus
Bab berjudul “Peran khusus”Peran bawaan sudah mencakup struktur tim yang umum. Pembuatan peran khusus sedang dalam rencana — jika hal ini diperlukan oleh tim Anda, Hubungi kamiKasus Anda akan langsung membantu kami memprioritaskan fitur ini.
Teruskan dari Referensi Pengendalian Akses
Judul bagian “Teruskan dari Referensi Pengendalian Akses”Jika Anda menggunakan Pengendalian Akses untuk merencanakan dashboard dan API operasi, hubungkannya dengan API Ringkasan untuk detail implementasi di API Ringkasan, Intro untuk detail implementasi di Intro, API Kunci untuk detail implementasi di API Keys Perangkat untuk detail implementasi di Perangkat, dan Paket untuk detail implementasi di Paket.