Utiliser get_token

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X.
En savoir plus

L'utilitaire get_token(1) vous permet d'échanger vos identifiants Apigee pour un accès et un jeton d'actualisation que vous pouvez utiliser pour accéder aux API Edge. Les jetons peuvent également être utilisés avec le protocole SAML. et LDAP des workflows OAuth2.

get_token vous permet d'effectuer les opérations suivantes:

  • Obtenez un jeton d'accès ou d'actualisation.
  • Imprimez les jetons dans stdout pour les utiliser dans les variables et les commandes.
  • Stockez des jetons sur votre disque.

Vous pouvez ensuite ajouter un jeton valide dans vos requêtes à l'API Edge et obtenir un nouveau jeton lorsque le vôtre expire.

Condition préalable:Pour pouvoir utiliser get_token, vous devez l'installer.

Syntaxe de get_token

L'utilitaire get_token utilise la syntaxe suivante:

get_token -u USERNAME:PASSWORD [-m MFACODE]

ou

get_token -p passcode

Où :

Élément Obligatoire ? Description
USERNAME Facultatif. Veuillez saisir un nom d'utilisateur et un mot de passe, ou un code secret. Votre nom d'utilisateur Apigee, qui est généralement l'adresse e-mail associée à votre compte Apigee. Vous devez transmettre votre nom d'utilisateur ou un code secret la première fois que vous appelez get_token. Vous n'aurez pas besoin de transmettre votre adresse e-mail jusqu'à ce que les jetons d'accès et d'actualisation aient expiré. Si vous mettez en cache des jetons pour plusieurs utilisateurs, vous devez spécifier votre nom d'utilisateur à chaque appel.
PASSWORD Facultatif. Veuillez saisir un nom d'utilisateur et un mot de passe, ou un code secret. Mot de passe de votre compte Apigee. Si vous omettez le mot de passe, vous serez invité à saisissez-le la première fois que vous utilisez get_token et lors de tous les appels suivants sans valeur d'actualisation. Si vous ne souhaitez pas utiliser votre mot de passe directement dans la commande, vous pouvez utiliser un un code secret à usage unique au lieu de votre mot de passe.
MFACODE Optional Un algorithme multifacteur temporaire à six chiffres (MFA). Ce code est obligatoire si vous utilisez -u et que la MFA est activée. Un message s'affichera si vous l'omettez (sauf en mode code secret). Si la MFA n’est pas activée, ou si vous disposez d'un flux avec script, vous pouvez spécifier -m "" pour éviter les invites.
PASSCODE Facultatif. Veuillez saisir un nom d'utilisateur et un mot de passe, ou un code secret. Un code secret à usage unique que vous pouvez utiliser à la place mot de passe. Un code secret est requis lors de l'authentification avec un IdP SAML et peut être utilisé pour s'authentifier auprès d'un IdP LDAP.

Exemple :

get_token
get_token -u ahamilton@apigee.com:mypassw0rd -m 424242
get_token -p mypass

Les appels réussis imprime un jeton d'accès valide sur stdout et stocke à la fois les les jetons d'accès et d'actualisation dans ~/.sso-cli. Vous pouvez utiliser ces jetons expirent, comme décrit dans la section Expiration des jetons.

Après votre premier appel réussi à get_token, vous n'avez pas besoin d'inclure votre les identifiants jusqu'à l'expiration des jetons.

Appeler get_token pour la première fois

Si vous n'indiquez aucune option lors du premier appel, get_token vous invitera à le faire les éléments suivants:

  • Un code secret en cas d'authentification auprès d'un fournisseur d'identité (IdP) SAML.
  • Votre nom d'utilisateur, votre mot de passe et un code MFA temporaire, sinon.

L'exemple suivant appelle get_token pour la première fois et utilise un nom d'utilisateur/mot de passe et un code MFA facultatif pour l'authentification:

get_token
Enter username:
ahamilton@apigee.com
Enter the password for user 'ahamilton@apigee.com':
[hidden input]
Enter the six-digit code if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:
123456

ey42bGciOiJSUzI1NiJ9.eyJqdGkiOiJhM2YwNjA5ZC1lZTIxLTQ1YjAtOGQyMi04MTQ0MTYxNjNhNTMiLCJzdWIiOiIyZDFl
  <snip>
VlLmNvbSIsInppZCI6InVhYSIsImF1ZCI6WyJlZGdlY2xpIiwic2NpbSIsIm9wZW5pZCIsInBhc3N3b3JkIiwiYXBwcm54242

Ajouter votre jeton d'accès à une requête

Après avoir appelé get_token, vous pouvez utiliser le jeton d'accès en le transmettant dans l'en-tête Authorization de vos appels à l'API Edge de plusieurs manières. Vous pouvez :

  • Copiez le contenu de la réponse get_token et insérez-le directement dans votre en-tête:
    curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
      -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
  • Combinez des commandes pour obtenir le jeton et l'ajouter à l'en-tête:
    token=$(get_token); curl -H "Authorization: Bearer $token" \
      https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Notez que get_token utilise la syntaxe de substitution de commande $(...). Ainsi, de son exécution.

  • Appelez get_token dans l'appel curl:
    curl -H "Authorization: Bearer $(get_token)" \
      https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Notez que get_token utilise la syntaxe de substitution de commande $(...). Ainsi, de son exécution.

Ces exemples de requêtes permettent d'obtenir des informations sur l'instance "ahamilton-eval". organisation. Pour obtenir la liste complète, des points de terminaison de l'API Edge, consultez la documentation de référence de l'API Apigee Edge.

Utiliser get_token avec SAML et LDAP

L'utilitaire get_token peut être utilisé avec SAML, LDAP ou tout autre IdP sous-jacent. get_token permet d'utiliser plusieurs URL de connexion SSO et plusieurs comptes. Un utilisateur disposant de plusieurs comptes sera invité à spécifier son nom d'utilisateur pour chaque appel get_token.

Vider le cache get_token

Vous pouvez utiliser les options facultatives suivantes pour vider le cache get_token:

  • --clear-sso-cache

    Efface le répertoire de cache de SSO_LOGIN_URL sous $HOME/.sso-cli en supprimant tous les jetons d'accès et d'actualisation mis en cache pour le serveur.

  • --clear-all-sso-cache

    Efface tous les répertoires sous $HOME/.sso-cli, en supprimant tous les jetons mis en cache.


(1) Copyright 2023 Google LLC
L'outil get_token est désormais disponible en tant que "Logiciel". sous la section contrat régissant votre utilisation de Google Cloud Platform, y compris du Service Les conditions d'utilisation spécifiques sont disponibles à l'adresse https://cloud.google.com/terms/service-terms.