9.7.9. Création ou suppression d'un token d'accès d'un API

9.7.9.1. Introduction

L'authentification sur l'API de la GBox peut se faire de deux manières :

  • en utilisant d'un couple login / mot de passe

  • en utilisant d'un token d'api

Les paramètres d'un token sont les suivants :

  • nom (requis) : nom permettant d'identifier le possesseur ou l'utilisation faite du token

  • permissions (requis) : niveau d'accès du token parmi Operators, Administrators ou Super Administrator

  • une date d'expiration : permet de désactiver le token à la date et l'heure indiquée.
    Si ce champ n'est pas rempli, le token n'expire pas.

Cette procédure décrit :

  • l'ajout d'un token d'accès d'un API

  • la création de ce token d’accès

  • la suppression éventuelle d'un token existant

Note

L'interface graphique est décrite dans la Partie `API tokens` du sous menu `Accounts`.

9.7.9.2. Prérequis

  • Utilisateur : membre du groupe Administrators

9.7.9.3. Opérations préliminaires

9.7.9.4. Procédure d’accès à la fenêtre `Permissions history`

  • Dans la barre de navigation, cliquer successivement sur :

  • le bouton `Admin`

  • le sous menu `Gcenter`

  • la commande `Accounts`
    La fenêtre `Accounts` est affichée.
  • Cliquer sur la rubrique `Api tokens`.
    La fenêtre `Api tokens` est affichée.

9.7.9.5. Procédure de création d'un nouveau token

../../_images/BOX_API-01.PNG

  • Saisir un nom explicite de token dans le champ (2) `Name` de la zone (1) `Create a new token`.

  • Sélectionner le compte voulu (et donc les droits) à l'aide du champ (3) `Permissions`.

  • Si besoin, sélectionner la date d’expiration en cliquant dans le champ (4) `Expiration date` : utiliser le calendrier affiché.

  • Appuyer sur le bouton (5) `Create`.
    Après l'ajout :

    • un message de création du token est affiché

    • le token créé est affiché

    Token generated with success :
```n_Y9lzbKnhNhK7Sw4OfzLqOuFC_bxDC1rtHTHCT7aoNTSkw3S0Mfqxx06KXSXTjHXbglUx9_IV0XVz-I1g8p34-1i8NaY9Grasu_IrpA24JkWhz5UWul12ePiebn_SOaiFhJpjHLD8slMx2aW1hVhiqL92UbDwtJ6uej7wpZ-IM```
Make sure you save it, you won't be able to access it again.
  • Utiliser le token affiché.
    La liste de la zone (8) `Token list` est mise à jour.

  • Si besoin, supprimer les tokens expirés avec le bouton (6).

9.7.9.6. Procédure pour supprimer un token

  • Utiliser , si besoin, les champs `Name` (10) , `Permission` (9), `Expiration` (7) pour filtrer la liste.

  • Supprimer un token existant à l'aide du bouton corbeille.
    Une fenêtre de confirmation est affichée avec le message suivant
    Confirm deletion
Do you confirm the deletion of the API token nightwatch_token_oper ?

  • Appuyer sur le bouton `Confirm` pour confirmer la suppression.

  • Si besoin, supprimer les tokens expirés avec le bouton (6) `Purge expired tokens` ou via l'API /auth/tokens/purge-tokens/.

Note

La documentation de l'API de la GBox est disponible via Swagger en cliquant sur le lien présent dans le menu Administrators > GBOX > API.