Clés d'API
Les clés d'API authentifient vos scripts et vos outils auprès de l'API. Une clé agit au nom de l'utilisateur qui l'a créée : elle a les mêmes permissions que cet utilisateur.
Créer une clé
- Ouvrez votre Profil, à partir du menu sous votre avatar, en haut à droite.
- Dans la section Clés d'API, entrez un nom et une date d'expiration de la clé.
- Cliquez sur Créer une clé.
- Copiez la clé et conservez-la en lieu sûr, par exemple dans un gestionnaire de mots de passe ou dans le magasin de secrets de votre outil. Elle ne sera plus affichée.
Utiliser une clé
Passez la clé dans l'en-tête x-api-key de chaque requête :
curl -H "x-api-key: $RK_API_KEY" https://<your-red-kite-url>/api/
Supprimer une clé
Dans la section Clés d'API de votre profil, ouvrez le menu de la clé et cliquez sur Supprimer. Les requêtes qui utilisent la clé sont refusées immédiatement. Supprimez une clé dès qu'elle n'est plus utilisée, ou si elle pourrait avoir fuité.
Bonnes pratiques
- Une clé par intégration, avec un nom qui indique où elle est utilisée, pour pouvoir en révoquer une sans briser les autres.
- Des dates d'expiration rapprochées, renouvelées au besoin.
- Un utilisateur dédié pour chaque intégration, membre d'un groupe qui a seulement les permissions dont l'intégration a besoin. Puisqu'une clé a les permissions de son utilisateur, cela limite ce qu'une clé divulguée pourrait faire. Consultez Gérer les rôles et les permissions.