Référence du contrôle d'accès
Copiez un prompt de configuration incluant les étapes d'installation et le guide markdown complet pour ce plugin.
Capgo utilise un contrôle d'accès basé sur les rôles (RBAC) pour gérer ce que chaque membre de l'équipe peut faire. Les rôles sont organisés par périmètre — de l'organisation entière jusqu'à un seul bundle.
Pour un aperçu visuel de la gestion des membres dans le dashboard, consultez Organisation.
Scopes de rôle
Section intitulée « Périmètres des rôles »Chaque rôl’appartient à un périmètre qui détermine à quelle ressource il donne accès.
| Périmètre | S'applique à | Exemple d'utilisation |
|---|---|---|
| Organisation | L'organisation entière et toutes ses apps | Votre cofondateur devient Super Admin ; votre comptable devient Billing Manager |
| cible | Une seule application et ses canaux | A contractor working on one app gets App Developer |
| Canal | Un seul canal au sein d'une application | Un ingénieur QA ne gère que le staging canal |
| Bundle | Une seule version de bundle | Un réviseur a besoin d'un accès en lecture à une release spécifique |
Un membre peut détenir un rôle par périmètre ciblé — par exemple, un rôle d’organisation, un rôle sur l’app A et un autre rôle sur l’app B.
Rôles de l'organisation
Section intitulée « Rôles d’organisation »Ces rôles sont attribués lors de l’invitation d’un membre. Ils donnent accès à toute l’organisation.
| Rôle | Nom interne | Description |
|---|---|---|
| Super admin | org_super_admin | Équivalent du propriétaire. Contrôle total, y compris la suppression de l’organisation, la gestion de la facturation et le transfert d’applications. Attribué automatiquement au créateur de l’organisation. |
| Admin | org_admin | Full administration — manage members, apps, channels. Cannot delete the org, update billing, transfer apps, or promote users to Super Admin. |
| Gestionnaire de facturation | org_billing_admin | Accès facturation uniquement : consulter et modifier les informations de facturation, les factures et les logs d’audit de facturation. Aucun accès aux apps ou aux membres. |
| Membre | org_member | Accès en lecture seule à l'organisation et à toutes ses apps. |
Matrice des permissions de l'organisation
Section intitulée « Matrice des permissions de l'organisation »| Autorisation | Description | Super admin | Admin | Gestionnaire de facturation | Membre |
|---|---|---|---|---|---|
org.read | Voir l'organisation | ✅ | ✅ | ✅ | ✅ |
org.update_settings | Modifier le nom, le logo et l'e-mail de gestion | ✅ | ✅ | ❌ | ❌ |
org.delete | Supprimer définitivement l’organisation | ✅ | ❌ | ❌ | ❌ |
org.read_members | Afficher la liste des membres | ✅ | ✅ | ❌ | ✅ |
org.invite_user | Inviter de nouveaux membres | ✅ | ✅ | ❌ | ❌ |
org.update_user_roles | Modifier les rôles des membres (un Admin ne peut pas être promu Super Admin — bloqué par la hiérarchie des rôles) | ✅ | ✅ | ❌ | ❌ |
org.read_billing | View billing info and current plan | ✅ | ✅ | ✅ | ❌ |
org.update_billing | Mettre à jour le moyen de paiement et le plan | ✅ | ❌ | ✅ | ❌ |
org.read_invoices | Afficher les factures | ✅ | ✅ | ✅ | ❌ |
org.read_audit | Afficher le journal d’activité de l’organisation | ✅ | ✅ | ❌ | ❌ |
org.read_billing_audit | Afficher le journal d’audit de la facturation | ✅ | ✅ | ✅ | ❌ |
Rôles de l'app
Section intitulée « Rôles d'app »Limité à une seule app. Utilisez ces rôles lorsqu'un membre de l'équipe ne doit travailler que sur une app, et non sur toute l'organisation.
| Rôle | Nom interne | Description |
|---|---|---|
| Admin d'app | app_admin | Contrôle total sur une application — canaux, appareils, rôles utilisateur pour l'app. Ne peut pas supprimer ni transférer l'app (opérations au niveau de l'organisation). |
| Développeur d'app | app_developer | Envoyer des bundles, gérer les appareils, lancer des builds natifs, modifier les paramètres des canaux. Pas de suppression, pas de modification des paramètres de l'app, pas de création de canal. |
| Uploader d'app | app_uploader | Accès en lecture + envoi de nouvelles versions de bundles. |
| Lecteur d'app | app_reader | Lecture seule — stats, bundles, canaux, logs, appareils. |
| Aperçu de l'app | app_preview | Cycle de vie CI de preview lié à l'organisation et à l'app : envoyez un bundle et créez un canal de preview. La création de ce canal accorde automatiquement les droits de cycle de vie uniquement pour celui-ci. |
Matrice des permissions de l'app
Section intitulée « Matrice des permissions de l'app »| Autorisation | Description | Admin d'app | Développeur d'app | Uploader d'app | Lecteur d'app |
|---|---|---|---|---|---|
app.read | Voir les détails, stats et métadonnées de l'app | ✅ | ✅ | ✅ | ✅ |
app.update_settings | Modifier les paramètres de l'app | ✅ | ❌ | ❌ | ❌ |
app.read_bundles | Voir la liste des bundles uploadés | ✅ | ✅ | ✅ | ✅ |
app.upload_bundle | Envoyer une nouvelle version du bundle | ✅ | ✅ | ✅ | ❌ |
app.create_channel | Créer un nouveau canal | ✅ | ❌ | ❌ | ❌ |
app.read_channels | Voir les canaux | ✅ | ✅ | ✅ | ✅ |
app.read_logs | Voir les logs de livraison des mises à jour | ✅ | ✅ | ✅ | ✅ |
app.manage_devices | Assigner, forcer ou dissocier des appareils | ✅ | ✅ | ❌ | ❌ |
app.read_devices | Voir la liste des appareils | ✅ | ✅ | ✅ | ✅ |
app.build_native | Déclencher un build cloud natif | ✅ | ✅ | ❌ | ❌ |
app.read_audit | Consulter les logs d'activité de l'app | ✅ | ✅ | ✅ | ✅ |
app.update_user_roles | Gérer les assignations de rôles par application | ✅ | ❌ | ❌ | ❌ |
bundle.delete | Supprimer un bundle | ✅ | ❌ | ❌ | ❌ |
Ensemble de permissions App Preview
Section intitulée « Ensemble de permissions App Preview »Utiliser Aperçu de l'app (app_preview) pour une clé CI liée à l'organisation et à l'app qui gère le cycle de vie des previews de PR sans accès étendu à l'app ni à l'organisation.
Le app_preview L'association n'accorde que ces permissions au niveau de l'application :
| Autorisation | Permet de |
|---|---|
app.read | Lire l'app sélectionnée |
app.read_bundles | Lire les bundles uploadés |
app.upload_bundle | Envoyer un bundle |
app.create_channel | Créer un canal |
Lorsqu’une clé App Preview crée un canal, Capgo attribue automatiquement à cette clé un binding enfant channel_preview pour le nouveau canal uniquement :
| Autorisation | Permet de |
|---|---|
channel.read | Lire le canal créé par la clé |
channel.promote_bundle | Définir le bundle uploadé propre à la clé sur ce canal |
channel.delete | Supprimer ce canal |
Parce que app_preview conserve app.read, la clé peut énumérer les métadonnées des canaux dans l’application sélectionnée. Le lien enfant automatique est une gestion frontière : il n’accorde pas de mutations de cycle de vie pour un canal que la clé n’a pas créé.
Capgo enregistre la clé de prévisualisation qui a créé chaque canal et uploadé chaque bundle. Par conséquent, une clé App Preview peut créer chaque canal de prévisualisation non public dont elle a besoin, promouvoir son propre bundle, et supprimer de manière atomique ce canal et ce bundle avec channel delete --delete-bundle; il ne peut pas effectuer ces actions sur un canal default/main existant, sur le canal d’une autre clé de preview ou sur le bundle d’une autre clé.
Elle n’inclut pas app.update_settings, la gestion des appareils ou des rôles, channel.update_settings, channel.rollback_bundle, la gestion des appareils forcés, ou générique bundle.delete.
Rôles des canaux
Section intitulée « Rôles de canal »Limité à un seul canal. Utile pour accorder un accès ciblé à un canal de release spécifique.
| Rôle | Nom interne | Description |
|---|---|---|
| Admin de canal | channel_admin | Contrôle total d'un canal : paramètres, promotion/rollback des bundles, gestion des appareils forcés. |
| Lecteur de canal | channel_reader | Lecture seule — bundle actuel, historique, appareils forcés, logs d'audit. |
| Aperçu de canal | channel_preview | Assigné automatiquement à la clé App Preview ayant créé le canal : lecture, promotion de son propre bundle et suppression de ce canal. |
Matrice des permissions des canaux
Section intitulée « Matrice des permissions par canal »| Autorisation | Description | Admin de canal | Lecteur de canal | Aperçu de canal |
|---|---|---|---|---|
channel.read | Voir le canal et son bundle actuel | ✅ | ✅ | ✅ |
channel.update_settings | Modifier les paramètres du canal (toggles de plateforme, politique de mise à jour…) | ✅ | ❌ | ❌ |
channel.delete | Supprimer le canal | ✅ | ❌ | ✅ |
channel.read_history | Voir l'historique des assignations de bundles | ✅ | ✅ | ❌ |
channel.promote_bundle | Définir le bundle actif sur le canal | ✅ | ❌ | ✅ |
channel.rollback_bundle | Revenir à un bundle précédent | ✅ | ❌ | ❌ |
channel.manage_forced_devices | Forcer des appareils spécifiques sur ce canal | ✅ | ❌ | ❌ |
channel.read_forced_devices | Voir la liste des appareils forcés | ✅ | ✅ | ❌ |
channel.read_audit | Voir les logs d'activité du canal | ✅ | ✅ | ❌ |
Rôles des bundles
Section intitulée « Rôles de bundle »Limité à une seule version de bundle. Rarement nécessaire — la plupart des équipes utilisent des rôles au niveau de l’app.
| Rôle | Nom interne | Description |
|---|---|---|
| Administrateur de bundle | bundle_admin | Lire, mettre à jour les métadonnées et supprimer un bundle spécifique. |
| Consultant de bundle | bundle_reader | Accès en lecture seule à un bundle spécifique. |
Surcharges de permissions de canal (Dashboard)
Section intitulée « Remplacements des permissions de canal (Dashboard) »Dans le dashboard, l’accès aux canaux est déterminé par défaut par le rôl’applicatif de l’utilisateur. Pour un contrôle plus granulaire, vous pouvez remplacer les permissions de canaux spécifiques par utilisateur ou par groupe, sans modifier leur rôl’applicatif.
Les remplacements sont configurés depuis l’onglet Accès onglet en cliquant sur le bouton des permissions du canal (icône bouclier) à côté d’un utilisateur. Voir Organisation — Remplacement des permissions de canal pour un aperçu visuel.
Permissions surchargeables
Section intitulée « Permissions surchargeables »| Autorisation | Description | Comportement par défaut |
|---|---|---|
| Lecture | Voir le canal et son bundle actuel | Hérité du rôle d'application |
| Historique | Voir l’historique des assignations de bundles | Hérité du rôle d'application |
| Associer un bundle | Définir ou changer le bundle actif du canal | Hérité du rôle d'application |
Chaque permission peut être définie comme suit :
- Par défaut — héritée du rôle de l’application (par défaut)
- Autoriser — accord explicite, indépendamment du rôle de l’application
- Refuser — blocage explicite, indépendamment du rôle de l’application
Cela vous permet, par exemple, de donner à un App Reader la possibilité d’associer des bundles sur le staging canal sans les promouvoir en tant qu'App Developer.
Hiérarchie des rôles
Section intitulée « Hiérarchie des rôles »Les rôles forment une hiérarchie. Un rôle parent hérite de toutes les permissions de ses rôles enfants. Cela signifie qu'un org_admin peut faire tout ce qu'un app_admin peut, ce qui à son tour peut tout faire qu'un channel_admin peut, et ainsi de suite.
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)Fonctionnement en pratique :
- Une Admin au niveau de l’organisation peut tout faire qu’un Admin d'app peut, sur chaque application de l'organisation.
- Une Admin d'app sur une application donnée peut faire tout ce qu'un Admin de canal peut, sur chaque canal de cette application.
- Une Développeur d'app peut faire tout ce qu'un Uploader d'app peut, et plus encore.
La hiérarchie ne se transmet que vers le bas — un channel_admin never gains org-level permissions, even if they also hold an app-level role.
Plutôt que d’attribuer des rôles à chaque utilisateur individuellement, vous pouvez créer des groupes et attribuer des rôles au groupe. Chaque membre du groupe hérite automatiquement de ces rôles.
Fonctionnement des groupes
Section intitulée « Fonctionnement des groupes »- Un groupe appartient à une seule organisation — elle ne peut pas s'étendre sur plusieurs organisations.
- Les groupes peuvent contenir des attributions de rôles à tout périmètre : organisation, app, canal ou bundle. Par exemple, un groupe peut se voir attribuer le Développeur d'app rôle sur l'app A et le Admin de canal rôle sur le
stagingcanal de l'app B. - Lors de l'évaluation des permissions d'un utilisateur, toutes ses appartenances aux groupes sont résolues de manière transparente. Si l'un de ses groupes accorde la permission requise, l'accès est autorisé.
- Un utilisateur peut appartenir à plusieurs groupes, et les permissions de tous les groupes s’additionnent.
- Les permissions de groupe ne s’appliquent qu’aux principaux de type utilisateur — les clés API n’héritent pas des rôles de groupe.
Quand utiliser les groupes
Section intitulée « Quand utiliser les groupes »| Scénario | Sans groupes | Avec des groupes |
|---|---|---|
| 5 ingénieurs QA ont besoin d'un accès Developer sur 3 apps | 15 attributions de rôl’individuelles | 1 groupe + 3 attributions de rôle |
| Quelqu'un rejoint l'équipe QA | Ajouter 3 attributions de rôle manuellement | Les ajouter au groupe |
| Quelqu'un quitte l'équipe QA | Supprimer 3 attributions de rôle manuellement | Les retirer du groupe |
Gérer les groupes via API
Section intitulée « Gestion des groupes via API »Tous les endpoints de groupe nécessitent une authentification et sont exposés sous /private/groups.
Lister les groupes
Section intitulée « Lister les groupes »curl -X GET "https://api.capgo.app/private/groups/<ORG_ID>" \ -H "authorization: <API_KEY>"Nécessite une org.read_members permission.
Créer un groupe
Section intitulée « Créer un groupe »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" }'Nécessite une org.update_user_roles permission (Super admin ou Admin).
Modifier un groupe
Section intitulée « Modifier un groupe »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" }'Supprimer un groupe
Section intitulée « Supprimer un groupe »curl -X DELETE "https://api.capgo.app/private/groups/<GROUP_ID>" \ -H "authorization: <API_KEY>"La suppression d'un groupe supprime aussi toutes ses associations de rôles. Les membres ne sont pas supprimés de l'organisation.
Lister les membres du groupe
Section intitulée « Lister les membres du groupe »curl -X GET "https://api.capgo.app/private/groups/<GROUP_ID>/members" \ -H "authorization: <API_KEY>"Ajouter un membre à un groupe
Section intitulée « Ajouter un membre à un groupe »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>" }'L’utilisateur doit déjà être membre de l’organisation. L’ajout d’un membre déjà présent est sans effet.
Retirer un membre d’un groupe
Section intitulée « Retirer un membre d’un groupe »curl -X DELETE "https://api.capgo.app/private/groups/<GROUP_ID>/members/<USER_UUID>" \ -H "authorization: <API_KEY>"Assigner des rôles via API
Section intitulée « Attribuer des rôles via API »Lister les membres
Section intitulée « Lister les membres »curl -X GET "https://api.capgo.app/organization/members" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "orgId": "<ORG_ID>" }'Réponse :
[ { "uid": "user-uuid", "email": "alice@example.com", "image_url": "https://...", "role": "org_admin", "is_tmp": false }]Inviter un membre
Section intitulée « Inviter un membre »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" }'Valeurs acceptées pour invite_type:
| Valeur | Rôl’attribué |
|---|---|
org_super_admin | Super admin |
org_admin | Admin |
org_billing_admin | Gestionnaire de facturation |
org_member | Membre |
Supprimer un membre
Section intitulée « Supprimer un membre »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" }'Assigner des rôles via CLI
Section intitulée « Assigner des rôles via CLI »Lister les organisations
Section intitulée « Lister les organisations »npx @capgo/cli organization list --apikey <API_KEY>Lister les membres
Section intitulée « Lister les membres »npx @capgo/cli organization members <ORG_ID> --apikey <API_KEY>Rôles personnalisés
Section intitulée « Rôles personnalisés »Les rôles intégrés couvrent la plupart des structures d’équipe. La création de rôles personnalisés est sur notre feuille de route — si c’est un besoin pour votre équipe, contactez-nous. Votre cas d’usage nous aidera directement à prioriser cette fonctionnalité.
Continuer avec la référence Contrôle d’accès
Section intitulée « Continuer depuis la référence de contrôle d’accès »Si vous utilisez Référence du contrôle d'accès pour planifier les opérations du dashboard et de API, connectez-l’avec Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans API Keys, Appareils pour les détails d'implémentation dans Devices, et Les bundles pour les détails d'implémentation dans Bundles.