acurl verwenden

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation.
Weitere Informationen

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

  • Tauschen Sie Ihre Apigee-Anmeldedaten gegen ein OAuth2-Zugriffstoken aus.
  • 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, eine ein Zugriffstoken mit dem Dienstprogramm get_token generiert wird.

Acurl installieren

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

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. Dazu ist eine Kombination aus Nutzername und Passwort oder ein Sicherheitscode erforderlich. Ihr Apigee-Nutzername. Dies ist normalerweise 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 aufgefordert, bei der ersten Verwendung von acurl sowie bei allen nachfolgenden Aufrufen ohne gültige Aktualisierungstoken. 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. Einen einmaligen Sicherheitscode, den Sie anstelle eines Passwort. Ein Sicherheitscode ist bei der Authentifizierung mit einem SAML-IdP erforderlich und kann verwendet werden für die Authentifizierung über einen LDAP-IdP.

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 Version von --max-time verwenden)
–P passcode proxy tunnel (muss die lange Version von --proxytunnel verwenden)
-v verbose verbose
-h help help (Langform von --help erforderlich)
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 acurl-Dienstprogramm unkompliziert und macht die manuelle Codierung von Anmeldedaten überflüssig. Nachdem Sie das Dienstprogramm heruntergeladen und installiert haben, können Sie Ersetzen:

curl -u username
durch:
acurl -u username

Das Dienstprogramm acurl codiert Ihr Anmeldedaten und fordern Sie gelegentlich zur Eingabe zusätzlicher Anmeldedaten auf, 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 Anruf mit acurl, bei dem Details zu einem Organisation mithilfe der Get Organisationsendpunkt:

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 Dienstprogramm acurl ruft ein Zugriffstoken ab und fügt es in den Aufruf des Edge API-Endpunkt:

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

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

Nach Ablauf des Zugriffstokens 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.

Diese Anfrage ruft Details zum „ahamilton-eval“ ab Unternehmen. Eine vollständige Liste aller Edge API-Endpunkte finden Sie in der Apigee Edge API-Referenz.


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