Vous utilisez des jetons d'API pour vous authentifier lorsque vous effectuez des connexions autorisées avec des API. Anciennement appelé jeton d'actualisation OAuth, un jeton d'API autorise l'accès par organisation.

Vous pouvez générer plusieurs jetons d'API. Un jeton est valide pour une période définie que vous configurez. Vous devez ensuite régénérer le jeton si vous souhaitez continuer à utiliser les API qui en dépendent. Si vous pensez qu'un jeton a été compromis, vous pouvez le révoquer pour éviter tout accès non autorisé. Vous pouvez générer un nouveau jeton pour renouveler l'autorisation.

Les jetons d'API sont inclus au sein d'organisations individuelles. Pour gérer une organisation de locataires à l'aide de l'API, vous devez générer un jeton d'API au sein de cette organisation.

Procédure

  1. Dans la barre d'outils VMware Cloud Provider Hub, cliquez sur votre nom d'utilisateur et sélectionnez Mon compte > Jetons d'API.
  2. Cliquez sur Générer un jeton.
  3. Entrez un nom pour le jeton, sélectionnez-en la période de validité, puis cliquez sur Générer.
    Un fenêtre contextuelle Jeton généré s'affiche. Vous pouvez copier, télécharger et imprimer le jeton.
  4. Cliquez sur Continuer.
    Une fois que vous avez cliqué sur Continuer, vous ne pouvez plus récupérer ce jeton. Vous pouvez le stocker dans un endroit sûr où vous pouvez y accéder.

Exemple : Utilisation d'un jeton d'API pour interagir avec les API VMware Cloud Provider Hub

Pour utiliser les API VMware Cloud Provider Hub, vous devez échanger le jeton généré contre un jeton d'authentification.
  1. Générer un jeton d'API.
  2. Échangez le jeton d'API contre un jeton d'authentification en effectuant une demande POST auprès de /cphub/api/auth/v1/authn/accesstoken avec "refreshToken" : "your_api_token" dans le corps de la demande.

    Vous devez définir l'en-tête Content-Type de cette demande POST sur application/json.

  3. Utilisez le jeton d'authentification reçu de l'en-tête csp-auth-token dans vos appels HTTP de script.
Pour plus d'informations sur l'utilisation des API VMware Cloud Provider Hub, reportez-vous au Guide de programmation des API VMware Cloud Provider Hub.

Que faire ensuite

Vous pouvez révoquer un jeton spécifique en cliquant sur le bouton Révoquer de ce jeton ou révoquer tous les jetons en cliquant sur le bouton Révoquer tous les jetons.