API Clés

Les API clés utilisent le contrôle d'accès basé sur le rôle (RBAC). Une clé peut avoir un rôl’applicable à l'organisation entière, des liens d'application, ou les deux. Chaque lien d'application reste associé à l'organisation propriétaire de l'application. Pour le moins de privilèges, restreignez une clé à des applications sélectionnées au lieu d'attribuer un rôl’applicable à l'organisation entière.

Où sont gérées les clés API ?

Naviguez vers Paramètres > Organisation > Clés API à console.capgo.app/settings/organization/api-keys.

La page affiche deux sections :

• Clés RBAC  — Clés avec des rôles attribués (recommandé). Ces clés utilisent le nouveau système de permission basé sur le rôle.
• Clés Legacy — Les clés plus anciennes utilisant le système de mode simple (read, upload, write, all) sans affectation de rôle.

Comment créer une nouvelle clé API ?

1. Cliquez sur le ”+” bouton

2. en haut de la table des clés RBAC. Remplissez les :

   • informations de clé Nom (obligatoire) — Un étiquette descriptive pour la clé (par exemple, « Déploiement CI/CD » ou « Lecture seule de Monitoring »).
   • Créer une clé sécurisée (facultatif) — Lorsque sélectionné, la clé est hachée côté serveur. La clé en texte brut est affichée seulement une fois après la création et ne peut pas être récupérée ultérieurement.
   • Fixer la date d'expiration (facultatif) — Sélectionnez une date après laquelle la clé cesse de fonctionner. Certaines organisations imposent une expiration obligatoire par politique.

3. Sélectionner la portée de la clé :

   • Accès organisationnel à grande échelle — Sélectionner un rôle d'organisation pour définir les permissions de base au sein de l'organisation. Les rôles disponibles dépendent du niveau de votre propre rôle :
     • Aucun — Pas d'accès organisationnel.
     • Membre — Accès de lecture de base à l'organisation.
     • Administrateur — Accès administratif complet à l'organisation et à tous ses applications.
   • Accès uniquement pour l'application — Activer Limitez cette clé aux applications sélectionnées. Chaque liaison d'application reste liée à l'application qui en est propriétaire ; ce mode omet uniquement un rôle RBAC organisationnel.

4. Si la clé doit créer des organisations via le public API, activer Permettre la création d'organisations.

   Cette fonctionnalité ajoute la permission globale. org.create La clé nécessite également une organisation scoping org_admin ou org_super_admin La clé nécessite également une organisation scoping ou La clé nécessite également une organisation scoping ou une organisation scoping. La clé nécessite également une organisation scoping ou une organisation scoping. org_admin binding. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.

5. La clé nécessite également une organisation scoping ou une organisation scoping.

   • La clé nécessite également une organisation scoping ou une organisation scoping. Pour accorder l'accès à l'application : Lorsque Lorsque la limitation de cette clé aux applications sélectionnées est activée, choisissez une organisation sous révéler ses applications. Les liens d'application sélectionnés restent associés à leurs organisations propriétaires ; ce filtre ne concède pas l'accès organisationnel.
   • Clicker ”+ Ajouter une application”, sélectionnez une ou plusieurs applications, puis attribuez un rôl’à chacune :
     • Lecteur d'application — Accès en lecture seule à l'application.
     • Téléchargeur d'application — Peut télécharger de nouveaux ensembles.
     • Développeur d'application — Peut télécharger des ensembles, gérer les appareils, déclencher des builds natifs et mettre à jour les paramètres de canal.
     • Administrateur d'application — Accès complet à l'application.
     • Aperçu d'application — Prévisualisez le cycle CI/CD : téléchargez un bundle et créez un canal de prévisualisation. Le canal reçoit des droits de cycle automatiques, uniquement pour ce canal.

6. Click « Créer ».

7. Si vous avez coché Créer une clé sécurisée, une fenêtre modale affiche la clé en texte brut. Copiez-l’immédiatement — il ne peut pas être récupéré après la fermeture de la fenêtre modale.

Utilisez une clé d'aperçu d'application pour les workflows de prévisualisation

Utilisez Prévisualisation d'application pour CI qui crée un canal de prévisualisation temporaire et non public, en charge et en promeut un bundle, puis supprime à la fois le canal et le bundle. Il n'a pas d'accès à la vie du cycle d'un canal par défaut ou principal existant.

1. Créez une clé RBAC et activez Limitez cette clé aux applications sélectionnées.
2. Sous Organisations pour filtrer les applications, sélectionnez l'organisation pour révéler ses applications ; chaque application sélectionnée reste associée à son organisation propriétaire.
3. Ajoutez uniquement l'application ou les applications utilisées pour les déploiements de prévisualisation.
4. Sélectionnez Prévisualisation d'application pour chaque application sélectionnée.
5. Créez une clé sécurisée, fixez une date d'expiration lorsque cela est approprié, et stockez-la dans votre gestionnaire de secrets CI.

Ce mode sélection-apps-seul omet un rôl’organisationnel ; il ne supprime pas l'association organisationnelle. Chaque liaison reste scoping à son application sélectionnée et à celle-ci appartenant à l'organisation. app_preview Accordez des autorisations et des limites

sur l'application sélectionnée	, et
app_preview liaison automatique	app.read, app.read_bundles, app.upload_bundleLorsque cette clé crée un canal, __CAPGO_KEEP_0__ donne automatiquement la clé app.create_channel.
liaison channel_preview rôle	When this key creates a channel, Capgo automatically gives the key channel.read, channel.promote_bundleet channel.delete pour ce canal uniquement.

app_preview garde app.read, de sorte que la clé puisse énumérer les métadonnées du canal dans l'application sélectionnée. La liaison automatique d'enfant est un gestion limites : elle ne concède pas les mutations de cycle de vie pour les canaux que la clé n'a pas créés.

Capgo enregistre également lequel de la clé d'App Preview a téléchargé un bundle. La clé peut définir uniquement son propre bundle sur chaque canal de prévisualisation qu'elle crée et peut nettoyer cette paire ensemble. Elle ne reçoit pas de liaison de canal pour un canal par défaut ou principal existant, un canal créé par une autre clé de prévisualisation ou un bundle d'une autre clé.

Pour un job CI typique, utilisez un nom de canal unique par demande de tirage :

APP_ID="com.example.app"
PREVIEW_CHANNEL="pr-123"
BUNDLE_VERSION="1.2.3-pr.123"

npx @capgo/cli@latest bundle upload "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --path ./dist \
  --channel "$PREVIEW_CHANNEL" \
  --bundle "$BUNDLE_VERSION"

npx @capgo/cli@latest channel delete "$PREVIEW_CHANNEL" "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --delete-bundle \
  --success-if-not-found

Pour un nouveau canal, bundle upload --channel crée le canal, télécharge le bundle et le promeut en un flux. La dernière commande utilise une route de nettoyage atomique étroite : elle réussit uniquement lorsque la clé possède le canal de prévisualisation et son bundle lié, non partagé. Aperçu de l'application n'a toujours pas de fonctionnalité générale bundle.deleteAinsi, il ne peut pas supprimer un bundle arbitraire.

Attention

Utilisez un nouveau canal non public. pr-<number> N'envoyez pas --default, --self-assignces options de lancement, ou --delete-linked-bundle-on-upload à ce flux de travail. Un Aperçu de l'application clé ne peut pas promouvoir, supprimer ou modifier un canal existant par défaut/principal, un canal d'une autre clé de prévisualisation ou un bundle d'une autre clé. La révocation ou l'expiration de la liaison de l'application supprime également l'accès à la durée de vie de la clé.

Consultez la Référence de Contrôle d'accès pour la frontière complète.

Comment gérer (éditer) une clé API ?

Cliquez sur l'icône de la clé à molette (Gérer) sur n'importe quelle clé RBAC de la liste. Cela ouvre la page détaillée de la clé où vous pouvez :

• Changer le nom de la clé Modifier le nom.
• Mettre à jour le rôle d'organisation.
• Activer ou désactiver Autoriser la création d'organisations lorsque la clé a un rôle d'organisation Admin.
• Ajouter, supprimer ou modifier rôles par application.

Cliquez sur « Enregistrer les modifications » page d'édition de la clé __CAPGO_KEEP_0__ avec les paramètres de rôl’actuels

Section intitulée « Comment régénérer une clé API ? »

To regenerate the secret value of an API key, click the Lorsque vous avez terminé. (Ré-générer) sur n'importe quelle clé de la liste.

Un dialogue de confirmation apparaîtra. Après confirmation :

• Pour clés sécurisées (hachées): Une nouvelle clé au texte brut est générée et affichée une fois dans un modal. Copiez-l’immédiatement.
• Pour clés au texte brut: La valeur de la clé est régénérée côté serveur.

Toute intégration utilisant la valeur de clé ancienne cessera de fonctionner immédiatement.

Comment supprimer une clé API ?

Appuyez sur l' l'icône de la poubelle (Supprimer) sur n'importe quelle clé de la liste. Confirmez la suppression dans le dialogue.

La clé est révoquée immédiatement — toute requête l'utilisant échouera.

Clés Legacy

Si vous voyez des clés dans la Sous-section intitulée « Clés Legacy » section (clés sans affectations de rôle), celles-ci utilisent le système de permission basé sur le mode plus ancien (read, upload, write, allElles fonctionnent toujours mais ne bénéficient pas des permissions RBAC fine grained.

Les clés Legacy peuvent être régénérées et supprimées de la liste, mais ne peuvent pas être éditées pour ajouter des rôles RBAC. Nous recommandons de créer de nouvelles clés RBAC et de supprimer les clés Legacy lorsque possible.

Si vous devez gérer les clés légendaires directement, vous pouvez toujours y accéder à console.capgo.app/dashboard/apikeys. Cette page est obsolète et sera supprimée dans une mise à jour future.

Continuez de API Clés

Si vous utilisez API Clés pour planifier le tableau de bord et les opérations de API , connectez-l’avec 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, API Clés pour le détail d'implémentation dans API Clés Appareils pour le détail d'implémentation dans Appareils, et Ensembles pour le détail d'implémentation dans Ensembles.