Langsung ke konten

Referensi Pengendalian Akses

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.


Setiap peran termasuk dalam ruang lingkup yang menentukan sumber daya apa yang memberikan akses.

Ruang Lingkupcontext: 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
OrganisasiSeluruh organisasi dan semua aplikasinyaKolaborator Anda mendapatkan Super Admin; akuntan Anda mendapatkan Billing Manager
AplikasiAplikasi tunggal dan saluran-salurannyaSeseorang yang bekerja sebagai pengembang aplikasi pada satu aplikasi mendapatkan App Developer
SaluranSaluran tunggal dalam aplikasiSeseorang yang hanya mengelola saluran staging Paket
__CAPGO_KEEP_0__A versi bundel tunggalSeorang 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-peran ini diberikan ketika mengundang anggota. Mereka memberikan akses di seluruh organisasi.

PeranNama InternalDeskripsi
Super Adminorg_super_adminSetara Pemilik. Pengontrolan penuh termasuk menghapus organisasi, mengelola tagihan, dan mentransfer aplikasi. Otomatis diberikan kepada pembuat organisasi.
Pengelolaorg_adminPengelolaan penuh — mengelola anggota, aplikasi, saluran. Tidak dapat menghapus organisasi, mengupdate tagihan, mentransfer aplikasi, atau mempromosikan pengguna menjadi Super Pengelola.
Pengelola Tagihanorg_billing_adminAkses tagihan saja: melihat dan mengupdate informasi tagihan, faktur, dan log audit tagihan. Tidak ada akses ke aplikasi atau anggota.
Anggotaorg_memberAkses baca-saja ke organisasi dan semua aplikasinya.
IzinDeskripsiPengelola UtamaAdminManajer BillingAnggota
org.readLihat organisasi
org.update_settingsUbah nama organisasi, logo, alamat email pengelola
org.deleteHapus organisasi secara permanen
org.read_membersLihat daftar anggota
org.invite_userUndang anggota baru
org.update_user_rolesUbah peran anggota (Admin tidak dapat mempromosikan ke Super Admin — diblokir oleh hierarki peran)
org.read_billingLihat informasi billing dan paket saat ini
org.update_billingUbah metode pembayaran dan paket
org.read_invoicesLihat faktur
org.read_auditView log aktivitas organisasi
org.read_billing_auditView log audit billing khusus

Terbatas pada satu aplikasi. Gunakan peran ini ketika anggota tim hanya boleh bekerja pada satu aplikasi, bukan seluruh organisasi.

PeranNama InternalDeskripsi
Pengelola Aplikasiapp_adminPenuh kontrol atas satu aplikasi — saluran, perangkat, peran pengguna untuk aplikasi. Tidak dapat menghapus atau mentransfer aplikasi (operasi tersebut adalah tingkat organisasi).
Pengembang Aplikasiapp_developerMuat bundle, kelola perangkat, trigger build native, ubah pengaturan saluran. Tidak dapat menghapus, tidak dapat mengubah pengaturan aplikasi, tidak dapat membuat saluran.
Pemuat Aplikasiapp_uploaderAkses baca + muat versi bundle baru.
Pembaca Aplikasiapp_readerAkses baca saja — statistik, paket, saluran, log, perangkat.
Pratinjau Aplikasiapp_previewPratinjau 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
IzinDeskripsiAdmin AplikasiPengembang AplikasiPengunggah AplikasiPembaca Aplikasi
app.readLihat detail aplikasi, statistik, dan metadata
app.update_settingsUbah pengaturan aplikasi
app.read_bundlesLihat daftar bundle yang diunggah
app.upload_bundleUnggah versi bundle baru
app.create_channelBuat saluran baru
app.read_channelsLihat saluran
app.read_logsLihat log pengiriman update
app.manage_devicesTetapkan, menggantikan, atau melepas perangkat
app.read_devicesLihat daftar perangkat
app.build_nativeAktifkan bangun awan asli
app.read_auditLihat log aktivitas aplikasi
app.update_user_rolesKelola penugasan peran aplikasi yang berlaku
bundle.deleteHapus bundle

yang dapat melakukan mereka, terlepas dari peran aplikasi.

Set Ijin Tampilan Aplikasi

Judul 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:

IzinMengizinkan
app.readMembaca aplikasi yang dipilih
app.read_bundlesMembaca bundle yang diunggah
app.upload_bundleMengunggah bundle
app.create_channelMembuat saluran

When an App Preview key creates a channel, Capgo automatically gives that key a child channel_preview Izin

MengizinkanMembuat saluran
channel.readBaca saluran yang dibuat oleh kunci
channel.promote_bundleSetel bundle yang diunggah sendiri oleh kunci tersebut pada saluran tersebut
channel.deleteHapus 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.


Disediakan untuk saluran perangkat lunak tunggal. Berguna untuk memberikan akses yang spesifik ke saluran rilis tertentu.

PeranNama internalDeskripsi
Pengelola Channelchannel_adminPenuh kontrol atas satu channel: pengaturan, promosikan/rollback bundle, mengelola perangkat paksa.
Penglihat Channelchannel_readerAkses baca saja — bundle saat ini, riwayat, perangkat paksa, log audit.
Penglihatan Channelchannel_previewDibuat secara otomatis oleh kunci App Preview yang membuat channel tersebut: baca, promosikan bundle sendiri, dan hapus channel tersebut.
IzinDeskripsiPengelola SaluranPenglihat SaluranPenglihatan Saluran
channel.readLihat saluran dan paket aktifnya saat ini
channel.update_settingsUbah pengaturan saluran (toggle platform, kebijakan update…)
channel.deleteHapus saluran
channel.read_historyLihat riwayat pengaturan paket
channel.promote_bundleSet paket aktif pada saluran
channel.rollback_bundleKembali ke bundle sebelumnya
channel.manage_forced_devicesForcekan perangkat tertentu ke saluran ini
channel.read_forced_devicesTampilkan daftar perangkat yang dipaksa
channel.read_auditTampilkan log aktivitas saluran

Terbatas pada versi bundle tunggal. Jarang dibutuhkan — kebanyakan tim menggunakan peran aplikasi daripada ini.

PeranNama internalDeskripsi
Pengelola Paketbundle_adminBaca, ubah metadata, dan hapus paket tertentu.
Penglihat Paketbundle_readerAkses baca-saja ke paket tertentu.

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.

IzinDeskripsiKebiasaan default
BacaLihat saluran dan paket terkiniDiteruskan dari peran aplikasi
RiwayatLihat riwayat pengaturan bundleDiteruskan dari peran aplikasi
Hubungkan bundleAtur atau ubah bundle aktif di saluranDiteruskan 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 induk

mengambil 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


__CAPGO_KEEP_0__ kelompok dan tambahkan peran ke kelompok tersebut. Setiap anggota kelompok akan mewarisi peran-peran tersebut secara otomatis.

  • 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. staging Ketika 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.
SkenarioTanpa kelompokDengan kelompok
5 insinyur QA memerlukan akses Developer ke 3 aplikasi15 pengikat peran individu1 kelompok + 3 pengikat peran
Seseorang bergabung dengan tim QATambahkan 3 pengikat peran secara manualTambahkan mereka ke kelompok
Seseorang meninggalkan tim QAHapus 3 pengikat peran secara manualHapus mereka dari kelompok

Semua endpoint grup memerlukan autentikasi dan disajikan di bawah /private/groups.

Jendela terminal
curl -X GET "https://api.capgo.app/private/groups/<ORG_ID>" \
-H "authorization: <API_KEY>"

Memerlukan org.read_members izin.

Jendela terminal
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).

Jendela terminal
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"
}'
Jendela terminal
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.

Jendela terminal
curl -X GET "https://api.capgo.app/private/groups/<GROUP_ID>/members" \
-H "authorization: <API_KEY>"
Jendela terminal
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.

Jendela Terminal
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”
Jendela terminal
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
}
]
Jendela terminal
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:

NilaiPeran yang diberikan
org_super_adminAdmin Utama
org_adminAdmin
org_billing_adminPengelola Tagihan
org_memberAnggota
Jendela Terminal
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"
}'

Jendela terminal
npx @capgo/cli organization list --apikey <API_KEY>
Jendela terminal
npx @capgo/cli organization members <ORG_ID> --apikey <API_KEY>

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.