Aller au contenu
northstar
Menu de la documentation

Clés API

Créer, conserver, envoyer et révoquer les clés qui authentifient un compte d’intégration.

En bref

Une clé API authentifie un compte d'intégration : chaque appel fait avec la clé agit au nom de ce compte, avec ses rôles et ses équipes. Une clé n'est affichée qu'une fois, à sa création. Northstar n'en garde qu'une empreinte. Une clé fonctionne jusqu'à sa révocation : pour la renouveler, créez la nouvelle avant de révoquer l'ancienne.

Créer une clé

  1. Ouvrez Développeurs depuis le menu de votre compte, puis le compte d'intégration.
  2. Sous Clés API, cliquez sur Créer une clé API et donnez-lui un Nom de la clé, par exemple « production » ou « recette ».
  3. Copiez la clé qui s'affiche. Elle ne sera plus affichée.

Les clés commencent par northstar_. La liste montre ensuite le nom de chaque clé, ses premiers caractères (Préfixe), son état (Active ou Révoquée), sa date de création et sa dernière utilisation.

Une clé appartient à l'organisation dans laquelle vous l'avez créée. Le compte doit rester membre de cette organisation pour que la clé fonctionne.

La conserver en sécurité

  • Placez la clé dans votre gestionnaire de secrets, ou dans l'environnement du processus qui exécute votre code, sous le nom NORTHSTAR_API_KEY.
  • Ne l'écrivez jamais dans le code, un notebook, un ticket ou un dépôt.
  • Utilisez une clé par environnement (production, recette, poste d'un développeur) : vous pourrez en révoquer une sans arrêter les autres.

Si une clé est perdue, personne ne peut la retrouver, pas même un administrateur : créez-en une nouvelle.

L'envoyer à chaque appel

Le SDK Python envoie la clé pour vous. Pour un appel HTTP direct, envoyez-la dans l'un de ces en-têtes :

http
X-API-KEY: northstar_…
Authorization: Bearer northstar_…

Une clé absente, inconnue ou révoquée reçoit une réponse 401 Unauthorized.

Durée de validité

Une clé n'a pas de date d'expiration. Elle cesse de fonctionner dès que :

  • elle est révoquée ;
  • son compte d'intégration est banni ou supprimé ;
  • son compte d'intégration est retiré de l'organisation.

Changer les rôles ou les équipes du compte ne change pas la clé : l'appel suivant reçoit simplement les nouveaux droits.

Renouveler ou révoquer une clé

Pour renouveler une clé sans interruption :

  1. Créez une nouvelle clé sur le même compte.
  2. Déployez-la là où l'ancienne était utilisée.
  3. Attendez que la dernière utilisation de l'ancienne clé ne bouge plus.
  4. Révoquez l'ancienne clé.

Révoquer arrête une clé immédiatement, et c'est irréversible. Révoquez tout de suite une clé qui a pu fuiter, puis créez-en une nouvelle.

Questions fréquentes

Puis-je revoir une clé après l'avoir créée ? Non. Northstar n'en conserve qu'une empreinte. Créez une nouvelle clé si vous l'avez perdue.

Une clé peut-elle servir dans plusieurs organisations ? Non. Une clé appartient à l'organisation dans laquelle elle a été créée.

Comment savoir quelle clé utilise un pipeline ? Comparez les premiers caractères de la clé avec la colonne Préfixe, et regardez sa dernière utilisation.

Voir aussi