Onglet Clés API

IMPORTANT
Pour des raisons de sécurité, le super administrateur (compte admin) ne peut pas créer ou regénérer des clés API, mais uniquement en révoquer ou en supprimer.
Seuls les comptes administrateurs disposant du droit spécifique Clés API sont autorisés à réaliser toutes les opérations (création, regénération, révocation et suppression).
De plus, chaque administrateur ne peut visualiser / modifier que ses propres clés API.

Les actions possibles

Filtrer Saisissez une chaîne de caractères pour n'afficher que les résultats contenant cette chaîne.
Sélecteur d'état

Sélectionnez l'état des clés API que vous voulez afficher dans la grille.

Les valeurs possibles sont les suivantes :

  • Toutes,
  • Actives,
  • Expirées,
  • Révoquées.
Créer

Ce bouton vous permet de créer une nouvelle clé API.

Pour créer une nouvelle clé API :

  1. Cliquez sur Créer.
  2. Saisissez un éventuel commentaire.
  3. Vous pouvez modifier la Durée de vie (jours) proposée par défaut pour cette clé.
  4. Sélectionnez les Droits attribués à la clé :
    • Gestion de la liste noire - Lecture seule : lecture seule uniquement sur les routes permettant de gérer la liste noire,
    • Gestion de la liste noire - Lecture / Écriture : lecture / écriture uniquement sur les routes permettant de gérer la liste noire,
    • Identiques à mes droits (droits de l'administrateur qui crée la clé).
  5. Cliquez sur Appliquer.
    L'assistant vous présente l'identifiant et le secret de la clé créée sous la forme identifiant:secret.
    Copiez les pour les conserver dans un endroit sûr : le secret ne peut plus être récupéré une fois la création de clé terminée.
  6. Cliquez sur Fermer.
    La clé est ajoutée à la grille.
Regénérer Ce bouton permet de prolonger la durée de vie de la clé API sélectionnée avec la durée de vie et les droits initialement affectés à cette clé.
Révoquer Ce bouton permet de rendre inactive la clé API sélectionnée. Cette clé devient alors inutilisable et apparaissait grisée dans la grille.
Supprimer

Ce bouton permet de supprimer la clé API sélectionnée.

Si la clé était active, elle est tout d'abord révoquée puis supprimée.
Rechercher dans les logs Sélectionnez une ou plusieurs clé API et cliquez sur ce bouton pour visualiser toutes les entrées de logs correspondant à ces clés.
Documentation API Cliquez sur ce lien pour accéder à la documentation API REST embarquée sur le firewall.

La grille

ID Affiche l'identifiant unique généré lors de la création de la clé API.
Propriétaire Affiche l'adresse e-mail de l'administrateur propriétaire de la clé.
Pour rappel, un administrateur ne peut visualiser que les clés dont il est propriétaire : seul le super administrateur visualise les clés de l'ensemble des administrateurs.
Date de création Affiche la date à laquelle la clé a été créée.
Date d'expiration Affiche la date à laquelle la clé expirera : il est possible de la regénérer avant cette date afin de prolonger sa durée de vie.
Durée de vie restante Affiche le nombre de jours restant jusqu'à l'expiration de la clé.
État Affiche l'état de la clé au cours de sa vie : active, expirée ou révoquée.
Commentaire Affiche le commentaire optionnel ajouté lors de la création de la clé.
Droits d'accès Affiche les droits affectés à la clé : la liste des droits varie selon le choix de droits attribués lors de la création de la clé.
Dernière utilisation Affiche la date et l'heure à laquelle la clé a été utilisée pour la dernière foi pour accéder à l'API REST du firewall.