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 ?

Navigatez vers Paramètres > Organisation > API Clés à console.capgo.app/settings/organisation/api-clés.

La page affiche deux sections :

• Clés RBAC — 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 — Clés plus anciennes qui utilisent le système de mode simple (read, upload, write, all) sans affectation de rôles.

Comment créer une nouvelle clé API ?

1. Cliquez sur le ”+” bouton en haut de la table des clés RBAC.

2. Remplissez les informations de la clé:

   • Nom (obligatoire) — Un étiquette descriptive pour la clé (par exemple « Déployer CI/CD », « Lecture seule de surveillance »).
   • Créer une clé sécurisée (facultatif) — Lorsque cochée, la clé sera hachée côté serveur. La clé au texte brut n'est visible que lors de la création. Vous ne pourrez pas la récupérer ultérieurement. Fixer une date d'expiration
   • button at the top of the RBAC keys table. (facultatif) — Sélectionnez une date à partir de laquelle la clé cesserait de fonctionner. Certaines organisations imposent une expiration obligatoire via une politique.

3. Sélectionnez 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 (en fonction du niveau de votre propre rôle) :

   • Aucun — Aucun accès organisationnel; la clé n'a accès qu'aux applications individuellement attribué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 API public, activez Permettre la création d'organisations.

   Cela ajoute la permission globale. Elle est disponible lorsque la clé a un rôle d'organisation Admin. Lorsque cette clé crée une nouvelle organisation, __CAPGO_KEEP_0__ attribue automatiquement la clé en tant que Super Admin sur cette nouvelle organisation. org.create permission. It is available when the key has an Admin organization role. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.

5. l'accès par application Cliquez sur:

   • ”+ Ajouter l'application” pour ouvrir le sélecteur d'applications. Sélectionnez une ou plusieurs applications, puis attribuez un rôle à chacune :
   • App Reader
     • — Accès en lecture seule à l'application. App Uploader
     • Per-app access — Puissez-vous télécharger de nouvelles archives.
     • Développeur d'application — Puissez-vous 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 affichera la clé en texte brut. Copiez-la immédiatement — Elle ne peut pas être récupérée après la fermeture du modal.

How gérer (modifier) 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é Mettre à jour le.
• rôle d'organisation Activer ou désactiver.
• Permettre la création d'organisations lorsque la clé a un rôle d'organisation Admin. Click the wrench icon (Gérer) on any RBAC key in the list. This opens the key detail page where you can:
• Ajouter, supprimer ou modifier rôles par application.

Cliquez “Sauvegarder les modifications” une fois terminé.

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 mise à jour (Régénérer) sur n'importe quelle clé de la liste.

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

• For des 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.For des clés au format texte :
• : 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.Confirmation de régénération de la clé __CAPGO_KEEP_0__

Comment supprimer une clé __CAPGO_KEEP_0__ ?

How to delete an API key?

__CAPGO_KEEP_0__ key regeneration confirmation How to delete an __CAPGO_KEEP_0__ key? Supprimer

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

Clés héritières

Si vous voyez des clés dans la Clés héritières section (clés sans affectations 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 devez gérer les clés héritières directement, vous pouvez toujours les 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 API , connectez-le 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 les détails d'implémentation dans API clés Appareils pour le détail d'implémentation dans Appareils, et Paquets pour le détail d'implémentation dans Paquets.