Utilizzo di acurl

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

L'utilità acurl(1) fornisce un pratico wrapper per il modello curl standard . acurl:

  • Scambia le tue credenziali Apigee con un token di accesso OAuth2.
  • Rileva la scadenza di un token di accesso e utilizza il token di aggiornamento per riceverne uno nuovo.
  • Trasmette il token nell'intestazione Authorization della richiesta API.

Puoi utilizzare i token di accesso per chiamare gli endpoint dell'API Edge con OAuth2, tra cui Flussi di lavoro LDAP e SAML.

Se utilizzi OAuth2 per accedere all'API Edge, ma non utilizzi acurl, devi: ottenere un token di accesso e aggiungerlo all'intestazione della richiesta API personalmente. Un modo per ottenere di accesso usa l'utilità get_token.

Installa acurl

Prima di poter utilizzare acurl, devi installarlo.

sintassi acurl

L'utilità acurl utilizza la seguente sintassi:

acurl API_URL -u USERNAME:PASSWORD [-m MFACODE]

o

acurl API_URL -p PASSCODE

Dove:

Opzione Obbligatorio? Descrizione
API_URL Obbligatorio L'endpoint API Apigee Edge. Per un elenco completo degli endpoint, consulta la documentazione di riferimento delle API Apigee Edge.
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 acurl 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 è abilitata la MFA o disponi di 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:

acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com -p 424242
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com:mypassw0rd
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com:mypassw0rd -m 123456

Oltre alle opzioni mostrate sopra, acurl accetta tutti i curl le opzioni di CPU e memoria disponibili. Ad esempio, puoi passare intestazioni, specificare il verbo HTTP, aggiungere un corpo e abilitare Livello di dettaglio utilizzando le opzioni curl standard:

Opzione acurl meaning curl meaning
-u username username
-min MFA code max time (è necessario utilizzare il formato lungo --max-time)
-P passcode proxy tunnel (è necessario utilizzare il formato lungo --proxytunnel)
-v verbose verbose
-h help help (è necessario utilizzare il formato lungo --help)
acurl -v -X POST -H 'Content-Type: application/json' \
    https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apiproducts/myproduct/attributes/attr \
    -u ahamilton@apigee.com -d '{"value":42}'

Una chiamata acurl andata a buon fine restituisce i risultati in base all'endpoint API Edge che hai selezionato chiamato. Inoltre, in acurl vengono archiviati sia i token di accesso che di aggiornamento nel mese di ~/.sso-cli.

Puoi continuare a effettuare chiamate senza inserire le credenziali (password e MFA facoltativa o passcode) finché sia il token di accesso del token di aggiornamento, come descritto in Scadenza del token.

Esegui la migrazione da curl

Se utilizzi curl, la migrazione all'utilità acurl è semplice e elimina la necessità di codificare manualmente le credenziali. Dopo aver scaricato e installato l'utilità, puoi: sostituisci:

curl -u username
con:
acurl -u username

L'utilità acurl codificherà la tua e a volte richiederanno le credenziali aggiuntive necessarie per ottenere nuove coppie di token.

L'utilità acurl può essere utilizzata anche per sostituire curl per gli utenti delle macchine. Per ulteriori informazioni, consulta OAuth2 per utenti di macchine e Utenti di macchine nelle zone SAML.

Chiama acurl per la prima volta

La prima volta che chiami l'API con acurl, fornisci le tue credenziali Apigee (il nome utente e password dell'account Apigee o un passcode) acurl può scambiarli con un token di accesso e un token di aggiornamento.

L'esempio seguente mostra una chiamata iniziale con acurl per ottenere dettagli su un un'organizzazione utilizzando lo strumento Ottieni dell'organizzazione:

acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval \
  -u ahamilton@apigee.com
Enter the password for user 'ahamilton@apigee.com':
[hidden input]
Enter the six-digit code (no spaces) if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:
1a2b3c
{
  "createdAt" : 1491854501264,
  "createdBy" : "noreply_iops@apigee.com",
  "displayName" : "ahamilton",
  "environments" : [ "prod", "test" ],
  "lastModifiedAt" : 1491854501264,
  "lastModifiedBy" : "noreply_iops@apigee.com",
  "name" : "ahamilton",
  "properties" : {
    "property" : [ {
      "name" : "features.isSmbOrganization",
      "value" : "false"
    }, {
      "name" : "features.isCpsEnabled",
      "value" : "true"
    } ]
  },
  "type" : "trial"
}

L'utilità acurl riceve un token di accesso e lo inserisce nella chiamata alla chiamata Endpoint API Edge:

curl -H "Authorization: Bearer oauth2_access_token" ...

Il token di accesso è archiviato localmente in ~/.sso-cli e utilizzato per chiamate successive.

Dopo la scadenza del token di accesso, acurl lo utilizza automaticamente per recuperare un nuovo token di accesso. Alla scadenza del token di aggiornamento, acurl ti chiederà per le tue credenziali Apigee.

Questa richiesta restituisce i dettagli su "ahamilton-eval" dell'organizzazione. Per un elenco completo Per gli endpoint API Edge, consulta la pagina Riferimento API Apigee Edge.


(1) Copyright 2023 Google LLC
Lo strumento acurl è 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.