Vous utilisez des jetons d'API pour vous authentifier lorsque vous effectuez des connexions autorisées avec des API. Un jeton d'API (précédemment appelé jeton d'actualisation OAuth) est échangé contre un jeton d'accès et autorise l'accès par organisation. Vous générez des jetons d'API à partir de votre page de compte dans Console Cloud Services ou via VMware Cloud Services.

Les jetons sont générés à l'aide d'un algorithme spécial qui sélectionne des caractères alphanumériques. Chaque jeton est une combinaison unique de 65 caractères. Lorsque vous générez un jeton, vous déterminez sa durée et ses étendues :
  • La durée de vie d'un jeton peut aller de quelques minutes à plusieurs mois, ou être configurée pour ne jamais expirer. La durée par défaut est de six mois.
  • Les étendues permettent de contrôler les zones auxquelles votre jeton peut accéder dans une organisation (par exemple, quel rôle dans une organisation, quels services et le niveau des autorisations).

Conditions préalables

Assurez-vous que vous disposez d'un emplacement de stockage sécurisé et protégé pour vos jetons d'API.

Procédure

  1. Dans la barre d'outils Console Cloud Services, cliquez sur votre nom d'utilisateur et sélectionnez Mon compte > Jetons d'API.
  2. Cliquez sur le lien Générer un nouveau jeton d'API.
  3. Entrez un nom pour le jeton.
  4. Spécifiez la durée de vie souhaitée du jeton.
    Note : Un jeton sans date d'expiration peut être un risque de sécurité s'il est compromis. Si cela se produit, vous devez révoquer le jeton.
  5. Définissez les étendues du jeton. Votre sélection doit être basée sur les rôles pris en charge par votre compte d'utilisateur.
    Portée Description
    Rôles d'organisation Les rôles d'organisation déterminent l'accès d'un utilisateur aux ressources de l'organisation.
    • Sélectionnez un ou plusieurs rôles d'organisation pour votre jeton d'API.
    Rôles de service Les rôles de service sont créés dans des ensembles d'autorisations prédéfinis qui accordent l'accès à VMware Cloud services.
    • Utilisez l'icône de flèche en regard d'un nom de service pour développer les rôles disponibles pour ce service, puis sélectionnez un ou plusieurs rôles de service pour votre jeton d'API.
    Autorisations Certains services vous permettent d'effectuer une sélection plus granulaire en attribuant un ensemble limité d'autorisations disponibles pour un rôle de service.
    • Lorsque vous sélectionnez un rôle de service, les autorisations disponibles s’affichent sur le côté droit du tableau. Sélectionnez les autorisations de service appropriées pour votre jeton d'API.
    Si nécessaire, vous pouvez sélectionner Tous les rôles et donner à votre jeton l'accès à tous les rôles d'organisation et de service.
    Note : Même si vous attribuez un accès de type Tous les rôles à votre jeton, il ne dispose que des rôles d'accès que votre compte d'utilisateur prend en charge. Pour afficher les rôles d'organisation et de services dont vous disposez, accédez à la page Mon compte et sélectionnez l'onglet Mes rôles.
  6. (Facultatif) Cochez la case OpenID pour récupérer un jeton conforme à OpenID avec les détails étendus relatifs à l'utilisateur.
  7. (Facultatif) Définissez une préférence d'e-mail pour recevoir un rappel lorsque votre jeton est sur le point d'expirer.
  8. Cliquez sur Générer.
  9. Enregistrez le jeton dans un endroit sûr afin de pouvoir le récupérer et l'utiliser ultérieurement.
    Pour des raisons de sécurité, après la génération du jeton, nous n'affichons que son nom sur la page Jetons d'API et non ses informations d'identification. Cela signifie que vous ne pourrez plus réutiliser le jeton en copiant les informations d'identification depuis cette page.
  10. Cliquez sur Continuer.
    Outre les jetons d'API, vous pouvez utiliser des applications OAuth pour authentifier vos applications. Pour savoir quand utiliser des applications OAuth plutôt que des jetons d'API, reportez-vous à la section Quelle est la différence entre les applications OAuth et les jetons d'API.

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

Vous pouvez utiliser un jeton d'API pour interagir avec nos API en l'échangeant avec un jeton d'authentification.
  1. Générer un jeton d'API.
  2. Effectuez une opération POST vers https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize.
  3. Dans l'en-tête, incluez les demandes suivantes :
    • accept: application/json
    • content type: application/x-www-form-urlencoded/
  4. Dans le corps, incluez la demande refresh_token={token value}.
  5. Utilisez le jeton d'authentification de l'en-tête csp-auth-token dans vos appels HTTP de script.