Aller au contenu principal

Clés API

Les clés API authentifient les requêtes vers l'API de gestion ConsentForge. Elles sont différentes des tokens d'intégration — gardez-les secrètes et utilisez-les uniquement depuis votre backend.

Créer une clé API

Compte → Clés API → Créer une clé

  1. Saisir un nom descriptif (ex. « Sync backend — Production »)
  2. Sélectionner les portées nécessaires pour votre intégration (principe du moindre privilège)
  3. Définir une date d'expiration (optionnel, mais recommandé)
  4. Cliquer sur Créer

Copiez la clé immédiatement — elle n'est affichée qu'une seule fois.

Portées disponibles

PortéeAccès
properties:readLister et afficher les propriétés
properties:writeCréer et mettre à jour les propriétés
policies:readAfficher les politiques et versions
policies:writeCréer, publier, annuler des politiques
receipts:readAfficher les reçus de consentement
receipts:exportExporter les reçus (grands ensembles de résultats)
webhooks:readAfficher la configuration des webhooks
webhooks:writeCréer et mettre à jour les webhooks
users:readLister les utilisateurs du compte
users:writeInviter et supprimer des utilisateurs
scan:triggerDéclencher des scans via API
adminAccès complet — à utiliser avec parcimonie

Expiration des clés

Définissez une date d'expiration pour limiter les dommages en cas de compromission d'une clé. Les clés expirées cessent automatiquement de fonctionner.

Faites une rotation régulière des clés. Pour effectuer une rotation : créer une nouvelle clé → mettre à jour l'intégration → supprimer l'ancienne clé.

Révoquer une clé

Compte → Clés API → [Nom de la clé] → Révoquer

La révocation est immédiate. Toute intégration utilisant la clé recevra des réponses 401 Unauthorized.

Bonnes pratiques de sécurité

  • Stocker les clés dans des variables d'environnement ou un gestionnaire de secrets, jamais dans le code source
  • Utiliser une clé par intégration (plus facile de révoquer une seule clé compromise)
  • Utiliser la portée la plus restrictive qui fonctionne pour votre cas d'usage
  • Définir une expiration pour les clés dans les pipelines CI/CD