À propos d'acurl et de 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

Apigee fournit les utilitaires de commodité suivants pour générer et transmettre l'accès OAuth2 et d'actualisation. Vous utilisez ces jetons pour vous authentifier dans votre API Edge avec OAuth (y compris workflows SAML et LDAP):

  • acurl(1): fournit un wrapper pratique pour un type curl. Construit des requêtes HTTP en périphérie obtient des jetons d'accès et d'actualisation auprès de get_token, puis les transmet à The Edge API.
  • get_token(1): échange vos identifiants Apigee pour y accéder et actualiser les jetons que vous pouvez utiliser pour appeler l'API Edge.

Ces deux utilitaires échangent vos identifiants de compte Apigee (nom d'utilisateur et mot de passe, ou code secret) contre des Jetons OAuth2.

Les jetons créés par les utilitaires Apigee sont conformes aux Framework d'autorisation OAuth 2.0 caractéristiques.

L'utilisation des utilitaires Apigee pour obtenir des jetons ou accéder au serveur d'authentification pour les API Edge est facultative. Vous pouvez implémenter vos propres schémas pour générer des jetons d'accès OAuth2 et les envoyer dans vos requêtes à Edge API.

Installer acurl et get_token

Apigee fournit un fichier ZIP contenant acurl(1), get_token(1) et un script d'installation.

Pour installer acurl et get_token:

  1. Créez un répertoire d'installation sur votre ordinateur ou utilisez le répertoire usr/local/bin par défaut.
  2. Téléchargez le fichier ZIP d'installation depuis Apigee: 
    curl https://login.apigee.com/resources/scripts/sso-cli/ssocli-bundle.zip -O
  3. Décompressez le fichier téléchargé.
  4. Exécutez le script d'installation: 
    sudo ./install -b /usr/local/bin

    L'option -b spécifie l'emplacement des fichiers exécutables. Si vous ne spécifiez cette option, le script d'installation installe les utilitaires dans /usr/local/bin.

  5. Testez les installations: 
        acurl -h
    get_token -h

    Si l'installation réussit, ces commandes renvoient un texte d'aide pour les utilitaires.

Expiration des jetons

acurl et get_token génèrent des jetons avec les durées suivantes:

  • Les jetons d'accès expirent au bout de 12 heures.
  • Les jetons d'actualisation expirent au bout de 30 jours.

Par conséquent, une fois que vous avez effectué un appel d'API avec acurl ou get_token, vous pouvez continuer à utiliser la paire de jetons pendant 30 jours. Passé ce délai, vous devez saisir à nouveau votre des identifiants et d'obtenir de nouveaux jetons.

Définir le point de terminaison SSO

Avant d'effectuer votre premier appel, vous devez définir le point de terminaison du serveur d'autorisation pour l'API Edge que vous souhaitez utiliser avec acurl et get_token.

Depuis le terminal, définissez la variable d'environnement SSO_LOGIN_URL sur votre autorisation le point de terminaison du serveur. Exemple :

  • Pour les clients Cloud sans zone: 
    export SSO_LOGIN_URL=https://login.apigee.com
  • Pour les clients Cloud avec la zone: 
    export SSO_LOGIN_URL=https://zone_name.login.apigee.com
  • Pour les clients de cloud privé, contactez votre administrateur pour connaître le point de terminaison SSO approprié.

Utiliser un code secret à usage unique (obligatoire pour SAML)

Lorsque vous effectuez un appel d'API avec acurl ou get_token, vous devez vous authentifier accédez au pour recevoir une paire de jetons. Pour ce faire, vous pouvez transmettre nom d'utilisateur, mot de passe et un code MFA. Toutefois, si vous utilisez un IdP SAML ou si vous ne souhaitez pas pour utiliser votre mot de passe, vous pouvez obtenir un code secret à usage unique à la place.

Pour obtenir un code secret à usage unique:

  1. Saisissez l'URL suivante dans un navigateur: <ph type="x-smartling-placeholder">
      </ph>
    • Pour les clients Cloud sans zone: 
      https://login.apigee.com/passcode
    • Pour les clients Cloud avec la zone: 
      https://zone_name.login.apigee.com/passcode
    • Pour les clients de cloud privé, contactez votre administrateur pour connaître le point de terminaison SSO approprié.
  2. Connectez-vous à votre compte Apigee.
  3. Copiez le code secret à six caractères.
  4. Utilisez acurl ou get_token avec l'option -p et transmettez la comme dans l'exemple suivant: 
    get_token -p 1a2b3c

Afficher vos jetons

Lorsque vous exécutez correctement acurl ou get_token, les utilitaires créer un fichier de données dans ~/.sso-cli contenant les jetons et d'autres métadonnées.

Pour afficher les jetons, vous pouvez exécuter une commande semblable à celle-ci:

get_token -v

Cette commande affiche les revendications de jeton décodée, par exemple:

Decoded token claims:
 {
  "jti": "8018507e-9f34-4a90-bf97-ff226a06b19b",
  "sub": "858217a9-01a1-4111-8525-75ca555f5d5c",
  "scope": [
    "scim.emails.read",
    "scim.me",
    "openid",
    "password.write",
    "approvals.me",
    "scim.ids.read",
    "oauth.approvals"
          ],
  "client_id": "edgecli",
  "cid": "edgecli",
  "azp": "edgecli",
  "grant_type": "password",
  "user_id": "858217a9-01a1-4111-8525-75ca555f5d5c",
  "origin": "usergrid",
  "user_name": "myusername@google.com",
  "email": "myusername@google.com",
  "auth_time": 1597444772,
  "al": 0,
  "rev_sig": "6271c527",
  "iat": 1597444772,
  "exp": 1597487972,
  "iss": "https://login.apigee.com",
  "zid": "uaa",
  "aud": [
    "edgecli",
    "scim.emails",
    "scim",
    "openid",
    "password",
    "approvals",
    "scim.ids",
    "oauth"
        ]
    }
Current timestamp: 1597444983
Existing access token is still valid

(1) Copyright 2023 Google LLC
Les outils acurl et get_token deviennent des "logiciels". 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.