Clés API

Les clés API sont gérées au niveau de l'organisation avec un contrôle d'accès basé sur le rôle (RBAC). Chaque clé peut être affectée un rôle organisationnel et des rôles facultatifs par application, vous donnant un contrôle fin pour savoir ce que chaque clé peut accéder.

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

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

La page affiche deux sections :

• Clés RBAC — Les clés avec des rôles assignés (recommandé). Ces clés utilisent le nouveau système de permission basé sur les rôles.
• Clés Legacy — Les clés plus anciennes qui utilisent 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 situé en haut de la table des clés RBAC.

2. Remplissez les Informations de la clé:

   • Nom (obligatoire) — Une étiquette descriptive pour la clé (par exemple, « Déploiement CI/CD », « Lecture seule de surveillance »).
   • Créer une clé sécurisée (facultatif) — Lorsque cette case est cochée, la clé sera hachée côté serveur. La clé au texte brut est affichée seulement une fois
   • après la création. Vous ne pourrez pas la récupérer ultérieurement. Définir la date d'expiration

3. __CAPGO_KEEP_0__ formulaire de création de clé avec nom, option de clé sécurisée et expiration Sélectionner un rôle d'organisation

   • — Cela définit les permissions de base de la clé à travers l'ensemble de l'organisation. Les rôles disponibles (selon votre niveau de rôle) : « Aucun » — Aucun accès organisationnel; la clé n'a accès qu'aux applications individuellement assignées.
   • Membre — Accès de lecture de base à l'organisation.
   • Administrateur — Accès administratif complet à l'organisation (hérite de l'accès à toutes les applications).

4. Si la clé doit créer des organisations à travers le public API, activez Permettre la création d'organisations.

   Cela ajoute l'accès global. org.create Il est disponible lorsque la clé a un rôle d'administrateur d'organisation. Lorsque cette clé crée une nouvelle organisation, Capgo attribue automatiquement la clé en tant que Super Administrateur sur cette nouvelle organisation.

5. Si le rôle d'org sélectionné n'est pas Administrateur, vous pouvez ajouter l'accès par application:

   • Cliquez Ajouter l'application pour ouvrir le sélecteur d'applications.
   • Sélectionnez une ou plusieurs applications, puis attribuez un rôle à 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 gérer la configuration et les déploiements de l'application.
     • Administrateur d'application — Accès complet à l'application.

6. Cliquez « Créer ».

7. Si vous avez coché « Créer une clé sécurisée », un modal s'affichera avec la clé en texte brut. Copiez-la immédiatement — elle ne peut pas être récupérée après la fermeture du modal.

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

Cliquez sur l'icône en forme de clé de tournevis « (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 la clé nom.
• Mettre à jour rôle de l'organisation.
• Activer ou désactiver Permettre la création d'organisations lorsque la clé a un rôle d'administrateur d'organisation.
• Ajouter, supprimer ou modifier rôles par application.

Cliquez “Sauvegarder les modifications” lorsque c'est fait.

Comment régénérer une clé API?

Pour régénérer la valeur secrète d'une clé API , cliquez sur l'icône de rafraîchissement (Régénérer) sur n'importe quelle clé de la liste.

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

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

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

Comment supprimer une clé API ?

Cliquez sur 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 héritées

Si vous voyez des clés dans le Clés héritières section (clés sans affectation de rôle), elles utilisent le système de permission basé sur le mode (read, upload, write, all). Elles fonctionnent toujours mais ne bénéficient pas des permissions RBAC détaillées.

Les clés héritières 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 héritières lorsque possible.

Si vous avez besoin de gérer les clés héritières directement, vous pouvez toujours les accéder à console.capgo.app/dashboard/apikeys. Cette page est dépréciée et sera supprimée dans une mise à jour future.

Continuez à partir des Clés API

Si vous utilisez API Clés pour planifier le tableau de bord et les opérations API, connectez-le avec API Présentation pour les détails d'implémentation dans API Présentation, Introduction pour les détails d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, Appareils pour les détails d'implémentation dans Appareils, et Ensembles pour les détails d'implémentation dans Ensembles.