acurl verwenden

Sie sehen die Dokumentation zu Apigee Edge.
Sehen Sie sich die Apigee X-Dokumentation an.
info

Das Dienstprogramm acurl(1) bietet einen Convenience-Wrapper um einen standardmäßigen curl. . acurl:

  • Hiermit werden Ihre Apigee-Anmeldedaten gegen ein OAuth2-Zugriffstoken eingetauscht.
  • Erkennt, wenn ein Zugriffstoken abgelaufen ist, und verwendet das Aktualisierungstoken, um ein neues Zugriffstoken abzurufen.
  • Übergibt dieses Token im Authorization-Header der API-Anfrage.

Sie verwenden Zugriffstokens, um Edge API-Endpunkte mit OAuth2 aufzurufen, darunter: LDAP- und SAML.

Wenn Sie OAuth2 für den Zugriff auf die Edge API, aber nicht acurl verwenden, müssen Sie erhalten Sie ein Zugriffstoken und fügen es selbst in den Header der API-Anfrage ein. Eine Möglichkeit, ein Zugriffstoken zu erhalten, ist das Dienstprogramm get_token.

acurl installieren

Bevor Sie acurl verwenden können, müssen Sie es installieren.

acurl-Syntax

Das Dienstprogramm acurl verwendet die folgende Syntax:

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

oder

acurl API_URL -p PASSCODE

Wobei:

Option Erforderlich? Beschreibung
API_URL Erforderlich Der Apigee Edge API-Endpunkt. Eine vollständige Liste der Endpunkte finden Sie in der Apigee Edge API-Referenz.
USERNAME Optional. Es ist eine Kombination aus Nutzername und Passwort oder ein Sicherheitscode erforderlich. Ihr Apigee-Nutzername, in der Regel die E-Mail-Adresse, die mit Ihrem Apigee-Konto verknüpft ist. Wenn Sie get_token zum ersten Mal anrufen, müssen Sie Ihren Nutzernamen oder einen Sicherheitscode eingeben. Sie müssen Ihre E-Mail-Adresse bis die Zugriffs- und Aktualisierungs-Tokens abgelaufen sind. Wenn Sie Tokens im Cache speichern für mehr als einen Nutzer müssen Sie Ihren Nutzernamen bei jedem Aufruf angeben.
PASSWORD Optional. Dazu ist eine Kombination aus Nutzername und Passwort oder ein Sicherheitscode erforderlich. Das Passwort für Ihr Apigee-Konto. Wenn Sie das Passwort weglassen, werden Sie bei der ersten Verwendung von acurl und bei allen nachfolgenden Aufrufen ohne gültiges Aktualisierungstoken aufgefordert, es einzugeben. Wenn Sie Ihr Passwort nicht direkt im Befehl verwenden möchten, können Sie einen Einmalcode-Sicherheitscode statt deines Passworts.
MFACODE Optional Ein temporärer sechsstelliger Multi-Faktor-Authentifizierungs- Authentifizierungscode (MFA) ein. Dieser Code ist erforderlich, wenn Sie -u verwenden und MFA aktiviert haben. Wenn Sie keinen Wert eingeben, werden Sie zur Bestätigung aufgefordert (es sei denn, Sie verwenden den Sicherheitscodemodus). Wenn Sie MFA nicht aktiviert oder einen scriptbasierten Ablauf haben, können Sie -m "" angeben, um Aufforderungen zu vermeiden.
PASSCODE Optional. Dazu ist eine Kombination aus Nutzername und Passwort oder ein Sicherheitscode erforderlich. Ein Einmalpasscode, den Sie anstelle eines Passworts verwenden können. Ein Sicherheitscode ist bei der Authentifizierung mit einem SAML-IdP erforderlich und kann auch für die Authentifizierung mit einem LDAP-IdP verwendet werden.

Beispiel:

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

Zusätzlich zu den oben gezeigten Optionen akzeptiert acurl alle curl Optionen. Sie können beispielsweise Header übergeben, das HTTP-Verb angeben, einen Textkörper hinzufügen und Ausführlichkeit mit den standardmäßigen curl-Optionen:

Option acurl meaning curl meaning
-u username username
-m MFA code max time (muss die lange Form --max-time verwenden)
–P passcode proxy tunnel (muss die lange Version --proxytunnel verwenden)
-v verbose verbose
-h help help (muss die lange Version --help verwenden)
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}'

Ein erfolgreicher acurl-Aufruf gibt Ergebnisse auf Basis des Edge-API-Endpunkts zurück, den Sie aufgerufen. Außerdem speichert acurl sowohl das Zugriffs- als auch das Aktualisierungstoken in ~/.sso-cli

Du kannst weiterhin Anrufe tätigen, ohne Anmeldedaten (Passwort und optionales MFA oder Sicherheitscode) einzugeben bis sowohl das Zugriffstoken als auch der Aktualisierungstoken ablaufen, wie unter Ablauf des Tokens beschrieben.

Von curl migrieren

Wenn Sie curl verwenden, ist die Migration zum Dienstprogramm acurl ganz einfach und Sie müssen Anmeldedaten nicht mehr manuell codieren. Nachdem Sie das Dienstprogramm heruntergeladen und installiert haben, können Sie Folgendes ersetzen:

curl -u username
mit:
acurl -u username

Das acurl-Dienstprogramm codiert Ihre Anmeldedaten und fordert Sie gelegentlich auf, die zusätzlichen Anmeldedaten anzugeben, die zum Abrufen neuer Tokenpaare erforderlich sind.

Das Dienstprogramm acurl kann auch verwendet werden, um curl für Computernutzer zu ersetzen. Weitere Informationen Siehe OAuth2 für Computernutzer und Computernutzer in SAML-Zonen.

Acurl zum ersten Mal aufrufen

Wenn Sie die API zum ersten Mal mit acurl aufrufen, geben Sie Ihre Apigee-Anmeldedaten (den Ihres Apigee-Kontos oder einen Sicherheitscode), damit acurl kann sie gegen ein Zugriffstoken und ein Aktualisierungstoken austauschen.

Das folgende Beispiel zeigt einen ersten Aufruf mit acurl, um Details zu einer Organisation über den Endpunkt Organization abrufen abzurufen:

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"
}

Das acurl-Dienstprogramm ruft ein Zugriffstoken ab und fügt es in den Aufruf des Edge API-Endpunkts ein:

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

Das Zugriffstoken wird lokal in ~/.sso-cli gespeichert und für nachfolgende Aufrufe verwendet.

Nachdem das Zugriffstoken abgelaufen ist, verwendet acurl automatisch das Aktualisierungstoken, um ein neues Zugriffstoken. Wenn das Aktualisierungstoken abläuft, werden Sie von acurl dazu aufgefordert. für Ihre Apigee-Anmeldedaten.

Mit dieser Anfrage werden Details zur Organisation „ahamilton-eval“ abgerufen. Eine vollständige Liste der Edge API-Endpunkte finden Sie in der Apigee Edge API-Referenz.


(1) Copyright 2023 Google LLC
Das acurl-Tool wird im Rahmen der Vereinbarung zur Nutzung der Google Cloud Platform als „Software“ zur Verfügung gestellt, einschließlich der dienstspezifischen Nutzungsbedingungen unter https://cloud.google.com/terms/service-terms.