Passer à la navigation

Référence de contrôle d'accès

Capgo utilise Contrôle d'accès basé sur le rôle (RBAC) pour gérer ce que chaque membre de l'équipe peut faire. Les rôles sont organisés par portée — de l'ensemble de l'organisation jusqu'à un seul bundle.

Pour une présentation visuelle de la gestion des membres dans le tableau de bord, voir Organisation.


Chaque rôle appartient à une portée qui détermine à quoi il accorde accès.

PortéePortéeExemple d'utilisation
OrganisationL'ensemble de l'org et tous ses applicationsVotre co-fondateur obtient Super Administrateur ; votre comptable obtient Gestionnaire de facturation
ApplicationUne seule application et ses canauxUn prestataire travaillant sur une application obtient Développeur d'application
CanauxUn seul canal au sein d'une applicationUn ingénieur QA ne gère que le staging canal
PackUne seule version de packA un reviewer nécessite accès en lecture à une version spécifique

Un membre peut détenir un rôle par cible de portée — par exemple, un rôle d'org, un rôle sur l'application A et un rôle différent sur l'application B.


Ces rôles sont attribués lors de l'invitation d'un membre. Ils accordent l'accès à l'ensemble de l'organisation.

RôleNom interneDescription
Administrateur supérieurorg_super_adminÉquivalent à propriétaire. Contrôle total, y compris la suppression de l'org, la gestion des factures et le transfert d'applications. Attribué automatiquement au créateur de l'org.
Administrateurorg_adminAdministration complète — gérer les membres, les applications, les canaux. Impossible de supprimer l'org, de mettre à jour la facturation, de transférer les applications ou de promouvoir les utilisateurs en Super Administrateur.
Gestionnaire de facturationorg_billing_adminAccès facturation uniquement : afficher et mettre à jour les informations de facturation, les factures et les journaux de suivi de facturation. Pas d'accès aux applications ou aux membres.
Membreorg_memberAccès en lecture seule à l'org et à toutes ses applications.
PermissionDescriptionSuper AdministrateurAdministrateurGestionnaire des facturesMembre
org.readVoir l'organisation
org.update_settingsModifier le nom, le logo et l'adresse e-mail de gestion de l'organisation
org.deleteSupprimer définitivement l'organisation
org.read_membersVoir la liste des membres
org.invite_userInviter de nouveaux membres
org.update_user_rolesChanger les rôles des membres (l'administrateur ne peut pas promouvoir à Super Administrateur — bloqué par la hiérarchie des rôles)
org.read_billingVoir les informations de facturation et le plan actuel
org.update_billingMettre à jour le moyen de paiement et le plan
org.read_invoicesVoir les factures
org.read_auditVoir le journal d'activité de l'organisation
org.read_billing_auditAfficher le journal d'audit spécifique à la facturation

peut faire, dans tous les applications et canaux.

Rôles d'application : Section intitulée « Rôles d'application »

Attribué à une seule application. Utilisez-ces rôles lorsque l'un des membres de l'équipe devrait travailler uniquement sur une application, et non sur toute l'organisation.

RôleNom interneDescription
Administrateur d'applicationapp_adminContrôle total d'une application — canaux, appareils, rôles d'utilisateur pour l'application. Impossible de supprimer ou de transférer l'application (ce sont des opérations au niveau de l'organisation).
Développeur d'applicationapp_developerTéléversez des bundles, gérez des appareils, déclenchez des builds natives, mettez à jour les paramètres des canaux. Pas de suppression, pas de modifications des paramètres de l'application, pas de création de canaux.
Téléverseur d'applicationapp_uploaderAccès en lecture + téléversement de nouvelles versions de bundle.
Lecteur d'applicationapp_readerAccès en lecture uniquement — statistiques, bundles, canaux, journaux, appareils.
Aperçu de l'applicationapp_previewCycle de vie de CI lié à l'aperçu de l'application et à l'organisation : téléchargez un bundle et créez un canal de prévisualisation. La création de ce canal accorde automatiquement les droits de cycle de vie uniquement pour celui-ci.

Matrice de permissions de l'application

Matrice de permissions de l'application
PermissionDescriptionAdministrateur de l'applicationDéveloppeur de l'applicationChargeur de l'applicationLecteur de l'application
app.readAfficher les détails de l'application, les statistiques et les métadonnées
app.update_settingsÉditer les paramètres de l'application
app.read_bundlesAfficher la liste des ensembles téléchargés
app.upload_bundleTélécharger une nouvelle version d'un ensemble
app.create_channelCréer un nouveau canal
app.read_channelsAfficher les canaux
app.read_logsAfficher les journaux de livraison de mise à jour
app.manage_devicesAttribuer, définir en priorité ou délier les appareils
app.read_devicesAfficher la liste des appareils
app.build_nativeDéclencher une construction cloud native
app.read_auditAfficher le journal d'activité au niveau de l'application
app.update_user_rolesGérer les affectations de rôle au niveau de l'application
bundle.deleteSupprimer un ensemble

Ensemble des permissions d'affichage de l'application

Section intitulée « Ensemble des permissions d'affichage de l'application »

Utilisez Affichage de l'application (app_preview) pour une clé CI liée à l'organisation et à l'application qui gère le cycle de vie d'une prévisualisation de PR sans accès large à l'application ou à l'organisation.

Le app_preview seuls ces droits d'application sont accordés :

PermissionPermet
app.readLire l'application sélectionnée
app.read_bundlesLire les bundles téléchargés
app.upload_bundleTélécharger un bundle
app.create_channelCréer un canal

Lorsqu'une clé d'aperçu d'application crée un canal, Capgo attribue automatiquement à cette clé une clé enfant channel_preview seuls ces droits du canal sont accordés :

PermissionPermet
channel.readLire le canal créé par la clé
channel.promote_bundleConfigure la mise en ligne de la clé de ce canal
channel.deleteSupprimer ce canal

Parce que app_preview conservent app.read, la clé peut lister les métadonnées du canal sélectionné dans l'application. La liaison automatique de l'enfant est un limites de gestion : elle ne concède pas les mutations de cycle de vie pour un canal que la clé n'a pas créé. __CAPGO_KEEP_0__ enregistre la clé de prévisualisation qui a créé chaque canal et mis en ligne chaque bundle. Par conséquent, une clé de prévisualisation d'application peut créer chaque canal de prévisualisation non public dont elle a besoin, promouvoir sa propre mise en ligne, et supprimer atomiquement ce canal et ce bundle avec

Capgo records the preview key that created each channel and uploaded each bundle. Therefore an App Preview key can create each non-public preview channel it needs, promote its own bundle, and atomically delete that channel and bundle with channel delete --delete-bundleNe comprend pas

, la gestion des appareils ou des rôles app.update_settings, la gestion des appareils forcée, ou générique channel.update_settings, channel.rollback_bundleSet the key’s own uploaded bundle on that channel bundle.delete.


Limité à un seul canal. Utile pour donner un accès ciblé à un canal de version spécifique.

RôleNom interneDescription
Administrateur de canalchannel_adminContrôle total d'un canal : paramètres, promotion/retour en arrière de bundles, gestion de dispositifs forcés.
Voyeur de canalchannel_readerLecture seule — le bundle actuel, l'historique, les dispositifs forcés, le journal d'audit.
Prévisualisation de canalchannel_previewAttribué automatiquement à la clé App Preview qui a créé le canal : lecture, promotion de son propre bundle et suppression de ce canal.

Matrice de droits du canal

Matrice de droits du canal
PermissionDescriptionAdministrateur du canalVoyeur du canalAperçu du canal
channel.readAfficher le canal et son bundle actuel
channel.update_settingsModifier les paramètres du canal (tournures de plateforme, politique de mise à jour…)
channel.deleteSupprimer le canal
channel.read_historyAfficher l'historique des affectations de bundle
channel.promote_bundleDéfinir le bundle actif sur le canal
channel.rollback_bundleRevenir à un bundle précédent
channel.manage_forced_devicesForcez des appareils spécifiques à ce canal
channel.read_forced_devicesAfficher la liste des appareils contraints
channel.read_auditAfficher le journal d'activité du canal

Attribué à une seule version de bundle. Rarement nécessaire — la plupart des équipes utilisent des rôles d'application au lieu de cela.

RôleNom interneDescription
Administrateur de bundlebundle_adminLecture, mise à jour des métadonnées et suppression d'un bundle spécifique.
Voyant de bundlebundle_readerAccès en lecture seule à un bundle spécifique.

Survol des permissions de canal (Tableau de bord)

Sous-titre « Survol des permissions de canal (Tableau de bord) »

Dans le tableau de bord, l'accès au canal est déterminé par le rôle de l'application de l'utilisateur par défaut. Pour un contrôle plus granulaire, vous pouvez surpasser les permissions de canal spécifiques par utilisateur ou groupe sans modifier leur rôle d'application.

Les survol sont configurés à partir du rôle de l'application Accès Ouvrez la section en cliquant sur le bouton de permissions de canal (icône bouclier) à côté d'un utilisateur. Consultez Organisation — Surcharge des permissions de canal pour une présentation visuelle.

PermissionDescriptionComportement par défaut
LireAfficher le canal et son bundle actuelHérité du rôle d'application
HistoriqueAfficher l'historique d'affectation du bundleHérité du rôle d'application
Associer un bundleDéfinir ou modifier le bundle actif sur le canalHérité du rôle d'application

Chaque permission peut être définie sur :

  • Par défaut — hériter du rôle d'application (par défaut)
  • Autoriser — accorder explicitement, en fonction du rôle d'application
  • Interdire — bloquez explicitement, quel que soit le rôle de l'application

Cela vous permet, par exemple, de donner à un Lecteur d'application la possibilité de lier des lots sur le staging canal sans les promouvoir en Développeur d'application.


Les rôles forment une hiérarchie. Un rôle parent hérite de toutes les autorisations de ses enfants. Cela signifie que org_admin peut faire tout ce que app_admin peut faire, qui à son tour peut faire tout ce que channel_admin peut faire, 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)

Comment ça marche en pratique :

  • Un Administrateur à niveau d'organisation peut faire tout ce que peut faire un Administrateur d'application sur chaque application de l'organisation.
  • Un Administrateur d'application sur une application spécifique peut faire tout ce que peut faire un Administrateur de canal sur chaque canal de cette application.
  • Un Développeur d'application peut faire tout ce que peut faire un Développeur d'application de chargement peut faire plus.

La hiérarchie ne s'écoule que en aval — un channel_admin ne gagne jamais de permissions d'org, même s'ils détiennent également un rôle d'application.


Au lieu d'attribuer des rôles à chaque utilisateur individuellement, vous pouvez créer des groupes et affecter des rôles au groupe. Chaque membre du groupe hérite automatiquement de ces rôles.

  • Un groupe appartient à une organisation — il ne peut pas couvrir plusieurs organisations.
  • Les groupes peuvent conserver des liens de rôle à n'importe quel niveau: organisation, application, canal ou paquet. Par exemple, un groupe peut être affecté du Rôle développeur d'application rôle sur l'application A et le Rôle administrateur de canal rôle sur le staging canal de l'application B.
  • Lorsque les autorisations d'un utilisateur sont évaluées, toutes ses adhésions de groupe 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 autorisations de tous les groupes sont additives.
  • Les autorisations basées sur les groupes ne s'appliquent qu'aux principaux d'utilisateur — les clés API ne héritent pas des rôles de groupe.
ScénarioSans groupesAvec groupes
5 ingénieurs QA ont besoin d'accès au développeur pour 3 applications15 liens de rôle individuels1 groupe + 3 liens de rôle
Quelqu'un rejoint l'équipe QAAjouter 3 liens de rôle manuellementAjouter-les au groupe
Quelqu'un quitte l'équipe QASupprimer 3 liens de rôle manuellementSupprimer-les du groupe

Toutes les endpoints de groupe nécessitent une authentification et sont servis sous /private/groups.

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

Exige org.read_members la permission.

Fenêtre de 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"
}'

Exige org.update_user_roles la permission (Super Administrateur ou Permission d'administration).

Fenêtre de 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"
}'
Fenêtre de terminal
curl -X DELETE "https://api.capgo.app/private/groups/<GROUP_ID>" \
-H "authorization: <API_KEY>"

La suppression d'un groupe supprime également toutes ses liaisons de rôle. Les membres ne sont pas supprimés de l'organisation.

Lister les membres du groupe

Fenêtre de terminal
Copier dans le presse-papier
curl -X GET "https://api.capgo.app/private/groups/<GROUP_ID>/members" \
-H "authorization: <API_KEY>"

Section intitulée « Ajouter un membre à un groupe »

Fenêtre de terminal
Copier dans le presse-papier
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>" }'

Supprimer un membre d'un groupe

Section intitulée « Lister les membres du groupe »

Section intitulée « Supprimer un membre d'un groupe »
Fenêtre de terminal
curl -X DELETE "https://api.capgo.app/private/groups/<GROUP_ID>/members/<USER_UUID>" \
-H "authorization: <API_KEY>"

Fenêtre de terminal
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
}
]
Fenêtre de 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"
}'

Valeurs acceptées pour invite_type:

ValeurRôle attribué
org_super_adminAdministrateur supérieur
org_adminAdministrateur
org_billing_adminGestionnaire de facturation
org_memberMembre
Fenêtre de 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"
}'

Fenêtre de terminal
npx @capgo/cli organization list --apikey <API_KEY>
Fenêtre de terminal
npx @capgo/cli organization members <ORG_ID> --apikey <API_KEY>

Les rôles intégrés couvrent la plupart des structures d'équipe. La création de rôles personnalisés est prévue dans notre roadmap — si cela est quelque chose dont votre équipe a besoin, nous vous invitons à nous contacterVotre cas d'utilisation contribuera directement à notre priorisation de cette fonctionnalité.

Si vous utilisez Contrôle d'accès pour planifier les tableaux de bord et les opérations API, connectez-le à API Vue d'ensemble pour les détails d'implémentation dans API Vue d'ensemble, Introduction pour les détails d'implémentation dans Introduction, Clés API pour les détails d'implémentation dans Clés API, Appareils pour le détail d'implémentation dans Appareils, et Ensembles pour le détail d'implémentation dans Ensembles.