Clés API et portées

Une clé API donne à un script ou à un service l'accès à votre espace de travail sans qu'une personne se connecte. Les clés portent des portées, une clé peut donc être limitée à ce que sa tâche exige.

Créer une clé

Connectez-vous en tant qu'administrateur et ouvrez Clés API.
Nommez la clé, choisissez ses portées et, si vous le souhaitez, une expiration en jours.
Copiez la clé quand elle s'affiche. Elle commence par xcrt_ et ne peut plus être affichée ensuite.

Seul un administrateur connecté peut créer ou révoquer une clé, et une clé ne peut recevoir que des portées que son créateur détient. Une nouvelle clé reçoit certs:read sauf si vous en choisissez d'autres.

Utiliser une clé

curl -H "Authorization: Bearer xcrt_your_key" \
     https://api.automate-certificates.com/v1/certificates

Portées

Portée	Autorise
`certs:read`	Lister et lire les certificats et leurs challenges.
`certs:write`	Demander, renouveler, importer, révoquer et supprimer des certificats.
`targets:read`	Lister et lire les cibles.
`targets:write`	Créer, modifier et supprimer des cibles.
`deploy:read`	Lire les déploiements.
`deploy:execute`	Exécuter des déploiements et gérer les règles de déploiement.
`monitoring:read`	Lire les résultats de supervision.
`alerts:read`	Lire les alertes.
`alerts:write`	Définir les règles d'alerte et gérer les webhooks.
`audit:read`	Lire le journal d'audit.

Ce qu'une clé délimitée ne peut pas faire

La gestion des membres, des rôles, des clés API, des comptes ACME et des identifiants cloud exige un administrateur connecté ou une clé à accès complet. Une clé délimitée est refusée avec 403 insufficient_scope, même si son propriétaire est administrateur. Quelques actions d'administration, comme lancer une analyse de découverte ou un renouvellement en masse, acceptent une clé qui détient la portée correspondante et appartient à un administrateur.

Limites

Chaque forfait autorise un nombre fixe de clés. Les requêtes sont limitées à 120 par minute pour un espace de travail.