Vous pouvez accéder aux API d'Orchestrator à l'aide de jetons au lieu d'une authentification basée sur une session. En tant que super utilisateur opérateur, vous pouvez gérer les jetons d'API. Vous pouvez créer plusieurs jetons d'API pour un utilisateur.

Note : Pour les utilisateurs en lecture seule d'entreprise et les utilisateurs experts commerciaux MSP, l'authentification par jeton n'est pas activée.
Par défaut, les jetons d'API sont activés. Pour les désactiver, accédez à Propriétés système (System Properties) dans le portail opérateur, puis définissez la valeur de la propriété système session.options.enableApiTokenAuth sur Faux (False).
Note : Le super utilisateur opérateur doit supprimer manuellement les utilisateurs de fournisseur d'identité (IdP) inactifs d'Orchestrator pour empêcher tout accès non autorisé via un jeton d'API.

Les utilisateurs peuvent créer, révoquer et télécharger les jetons en fonction de leurs rôles.

Pour gérer les jetons d'API :
  1. Dans le portail opérateur, accédez à Administration > Gestion des utilisateurs (User Management) > Utilisateurs (Users).
  2. Sélectionnez un utilisateur, puis cliquez sur Modifier (Modify) ou sur le lien d'accès au nom d'utilisateur. Accédez à la section Jetons d'API (API Tokens).
  3. Cliquez sur Nouveau jeton d'API (New API Token).
  4. Dans la fenêtre Nouveau jeton (New Token), entrez un Nom (Name) et une Description pour le jeton, puis choisissez sa Durée de vie (Lifetime) dans le menu déroulant.
  5. Cliquez sur Enregistrer (Save). Le nouveau jeton s'affiche dans la table Jetons d'API (API Tokens). Initialement, l'état du jeton affiché est En attente (Pending). Une fois que vous l'avez téléchargé, l'état passe à Activé (Enabled).
  6. Pour télécharger le jeton, sélectionnez-le, puis cliquez sur Télécharger le jeton d'API (Download API Token).
  7. Pour désactiver un jeton, sélectionnez-le, puis cliquez sur Révoquer le jeton d'API (Revoke API Token). L'état du jeton affiché est Révoqué (Revoked).
  8. Cliquez sur CSV pour télécharger la liste complète des jetons d'API au format de fichier .csv.
  9. Lorsque la durée de vie du jeton est écoulée, l'état passe à Expiré (Expired).
Note : Seul l'utilisateur associé à un jeton peut le télécharger et ensuite, seul l'ID du jeton s'affiche. Vous ne pouvez télécharger un jeton qu'une seule fois. Après le téléchargement du jeton, l'utilisateur peut l'envoyer comme partie intégrante de l'en-tête d'autorisation de la demande pour accéder à l'API Orchestrator.
L'exemple suivant montre un exemple d'extrait de code permettant d'accéder à une API.
curl -k -H "Authorization: Token <Token>"
  -X POST https://vco/portal/
  -d '{ "id": 1, "jsonrpc": "2.0", "method": "enterprise/getEnterpriseUsers", "params": { "enterpriseId": 1 }}'
De même, vous pouvez configurer des propriétés supplémentaires et créer des jetons d'API pour les administrateurs partenaires, les clients d'entreprise et les clients partenaires. Pour plus d'informations, reportez-vous à la section :
  • « Utilisateurs » du Guide d'administration de VMware SD-WAN
  • « Utilisateurs » du Guide du partenaire de VMware SD-WAN
Les autres options suivantes sont disponibles dans l'onglet Jetons d'API (API Tokens) :
Option Description
Rechercher (Search) Entrez un terme de recherche pour rechercher le texte correspondant dans le tableau. Utilisez l'option de recherche avancée pour affiner les résultats de la recherche.
Colonnes (Columns) Cliquez sur cette option et sélectionnez les colonnes à afficher ou à masquer sur la page.
Actualiser (Refresh) Cliquez sur cette option pour actualiser la page afin d'afficher les données les plus récentes.