Uso del metodo get_token

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X.
Informazioni

L'utilità get_token(1) ti consente di scambiare le tue credenziali Apigee per un accesso e aggiorna il token che puoi usare per accedere alle API Edge. I token possono essere utilizzati anche con SAML e LDAP dei flussi di lavoro OAuth2.

get_token ti consente di:

  • Ottieni un token di accesso o di aggiornamento.
  • Stampa i token su stdout per utilizzarli in variabili e comandi.
  • Archivia i token sul disco.

Puoi quindi aggiungere un token valido nelle tue richieste all'API Edge e riceverne uno nuovo alla scadenza.

Prerequisito: prima di poter utilizzare get_token, devi installarlo.

Sintassi get_token

L'utilità get_token utilizza la seguente sintassi:

get_token -u USERNAME:PASSWORD [-m MFACODE]

o

get_token -p passcode

Dove:

Elemento Obbligatorio? Descrizione
USERNAME Facoltativo. È necessaria una combinazione di nome utente e password o un passcode. Il tuo nome utente Apigee, che in genere corrisponde all'indirizzo email associato al tuo account Apigee. La prima volta che chiami get_token, devi inserire il tuo nome utente o un passcode. Non dovrai trasmettere l'email di destinazione finché i token di accesso e di aggiornamento non sono scaduti. Se stai memorizzando nella cache i token per più utenti, devi specificare il tuo nome utente in ogni chiamata.
PASSWORD Facoltativo. È necessaria una combinazione di nome utente e password o un passcode. La password del tuo account Apigee. Se ometti la password, ti verrà chiesto di inseriscilo la prima volta che utilizzi get_token e in tutte le chiamate successive senza un token di aggiornamento. Se non vuoi utilizzare la password direttamente nel comando, puoi utilizzare un un passcode monouso anziché la password.
MFACODE Facoltativo Un'architettura multifattore temporanea di autenticazione (MFA). Questo codice è obbligatorio se utilizzi -u e hai abilitato la MFA. Se ometti, ti verrà richiesto (a meno che non sia attiva la modalità con passcode). Se non hai abilitato MFA, o se hai un flusso basato su script, puoi specificare -m "" per evitare i prompt.
PASSCODE Facoltativo. È necessaria una combinazione di nome utente e password o un passcode. Un passcode monouso da utilizzare al posto di un password. È possibile utilizzare un passcode per l'autenticazione con un IdP SAML per l'autenticazione con un IdP LDAP.

Ad esempio:

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

Una chiamata riuscita stampa un token di accesso valido su stdout e archivia sia il token di accesso e di aggiornamento in ~/.sso-cli. Puoi utilizzare questi token finché non scadono, come descritto in Scadenza del token.

Dopo la prima chiamata al numero get_token, non è necessario includere il tuo fino alla scadenza dei token.

Chiamare get_token per la prima volta

Se non specifichi nessuna opzione durante la prima chiamata, get_token ti chiederà le seguenti:

  • Un passcode, se viene effettuata l'autenticazione con un provider di identità (IdP) SAML.
  • Il tuo nome utente, la tua password e un codice MFA temporaneo.

L'esempio seguente chiama get_token per la prima volta e utilizza un combinazione nome utente/password con un codice MFA facoltativo per l'autenticazione:

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

Aggiungere il token di accesso a una richiesta

Dopo aver chiamato get_token, puoi utilizzare il token di accesso passandolo nell'intestazione Authorization delle tue chiamate all'API Edge in vari modi. Puoi:

  • Copia il contenuto della risposta get_token e inseriscilo direttamente nel intestazione:
    curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
      -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
  • Combina i comandi per ottenere il token e aggiungerlo all'intestazione:
    token=$(get_token); curl -H "Authorization: Bearer $token" \
      https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Tieni presente che get_token utilizza la sintassi di sostituzione dei comandi $(...), quindi la sua esecuzione.

  • Chiama get_token nell'ambito della chiamata curl:
    curl -H "Authorization: Bearer $(get_token)" \
      https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Tieni presente che get_token utilizza la sintassi di sostituzione dei comandi $(...), quindi la sua esecuzione.

Queste richieste di esempio ricevono dettagli su "ahamilton-eval" dell'organizzazione. Per un elenco completo degli endpoint API Edge, consulta la pagina Riferimento API Apigee Edge.

Utilizzare get_token con SAML e LDAP

L'utilità get_token può essere utilizzata con SAML, LDAP o qualsiasi altro IdP sottostante. get_token supporta l'utilizzo di più URL di accesso SSO e di più account. A un singolo utente con più account verrà chiesto di specificare il nome utente per ogni chiamata get_token.

Svuotare la cache get_token

Puoi utilizzare i seguenti flag facoltativi per svuotare la cache di get_token:

  • --clear-sso-cache

    Cancella la directory della cache per SSO_LOGIN_URL in $HOME/.sso-cli ignorando eventuali token di accesso e di aggiornamento memorizzati nella cache per il server.

  • --clear-all-sso-cache

    Cancella tutte le directory in $HOME/.sso-cli eliminando tutti i token memorizzati nella cache.


(1) Copyright 2023 Google LLC
Lo strumento get_token è reso disponibile come "Software" nel contratto che regola l'utilizzo della piattaforma Google Cloud, incluso il Servizio Termini specifici disponibili all'indirizzo https://cloud.google.com/terms/service-terms.