Informacje o parametrach acurl i get_token

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Apigee udostępnia poniższe wygodne narzędzia do generowania i przekazywania dostępu OAuth2 i odświeżania tokenów. Tokenów używasz do uwierzytelniania się w interfejsie Edge API wywołań OAuth (w tym SAML i LDAP):

  • acurl(1): wygodny kod towarzyszący curl. Konstruuje żądania HTTP do Edge API, uzyskuje dostęp i tokeny odświeżania od get_token oraz przekazuje token dostępu do Edge API.
  • get_token(1): wymienia dane logowania Apigee, aby umożliwić dostęp do nich i odśwież tokeny, których można używać do wywoływania interfejsu Edge API.

Obie te narzędzia wymieniają dane logowania do konta Apigee (nazwę użytkownika i hasło lub kod dostępu) przy użyciu Tokeny OAuth2.

Tokeny utworzone przez narzędzia Apigee są zgodne z Platforma autoryzacji OAuth 2.0 specyfikacji.

Uzyskiwanie tokenów i dostęp do serwera uwierzytelniania w przypadku interfejsów Edge API przy użyciu narzędzi Apigee jest opcjonalne. Możesz implementować własne schematy, aby generować tokeny dostępu OAuth2 i wysyłać je w żądaniach do Edge API.

Zainstaluj acurl i get_token

Apigee udostępnia plik ZIP zawierający acurl(1), get_token(1) i skrypt instalacji.

Aby zainstalować aplikacje acurl i get_token:

  1. Utwórz na komputerze katalog instalacyjny lub użyj domyślnego katalogu usr/local/bin.
  2. Pobierz z Apigee plik ZIP instalacyjny: 
    curl https://login.apigee.com/resources/scripts/sso-cli/ssocli-bundle.zip -O
  3. Rozpakuj pobrany plik.
  4. Uruchom skrypt instalacji: 
    sudo ./install -b /usr/local/bin

    Opcja -b określa lokalizację plików wykonywalnych. Jeśli nie chcesz w przypadku tej opcji skrypt instalacji zainstaluje narzędzia w programie /usr/local/bin.

  5. Przetestuj instalacje: 
        acurl -h
            get_token -h

    Jeśli instalacja się powiedzie, te polecenia zwrócą tekst pomocy dotyczący narzędzi.

Wygaśnięcie tokena

acurl i get_token generują tokeny o następujących czasach trwania:

  • Tokeny dostępu wygasają po 12 godzinach.
  • Tokeny odświeżania tracą ważność po 30 dniach.

Dlatego po pomyślnym wywołaniu interfejsu API za pomocą acurl lub get_token możesz dalej używać tej pary przez 30 dni. Po wygaśnięciu konieczne będzie ponowne podanie dane logowania i wygeneruj nowe tokeny.

Ustawianie punktu końcowego logowania jednokrotnego

Przed wykonaniem pierwszego wywołania musisz ustawić punkt końcowy serwera autoryzacji dla interfejsu Edge API których chcesz używać z acurl i get_token.

W terminalu ustaw zmienną środowiskową SSO_LOGIN_URL na swoją autoryzację punktu końcowego serwera. Na przykład:

  • W przypadku klientów Cloud bez strefy: 
    export SSO_LOGIN_URL=https://login.apigee.com
  • W przypadku klientów Cloud ze strefą: 
    export SSO_LOGIN_URL=https://zone_name.login.apigee.com
  • Jeśli jesteś klientem Private Cloud, skontaktuj się z administratorem w sprawie odpowiedniego punktu końcowego logowania jednokrotnego.

Użyj jednorazowego kodu dostępu (wymaganego w przypadku SAML)

Gdy wywołujesz interfejs API za pomocą acurl lub get_token, musisz się uwierzytelnić się do do odbioru pary tokenów. Możesz to zrobić, przekazując Apigee nazwę użytkownika, hasło i kod MFA. Jeśli jednak używasz dostawcy tożsamości SAML lub nie chcesz, aby użyć hasła, możesz zamiast niego uzyskać jednorazowy kod dostępu.

Aby uzyskać jednorazowy kod dostępu:

  1. Wpisz w przeglądarce ten adres URL:
    • W przypadku klientów Cloud bez strefy: 
      https://login.apigee.com/passcode
    • W przypadku klientów Cloud ze strefą: 
      https://zone_name.login.apigee.com/passcode
    • Jeśli jesteś klientem Private Cloud, skontaktuj się z administratorem w sprawie odpowiedniego punktu końcowego logowania jednokrotnego.
  2. Zaloguj się na konto Apigee.
  3. Skopiuj 6-znakowy kod dostępu.
  4. Użyj acurl lub get_token z opcją -p i przekaż parametr jak w tym przykładzie: 
    get_token -p 1a2b3c

Wyświetlanie tokenów

Gdy wykonasz zadanie acurl lub get_token, narzędzia utwórz w narzędziu ~/.sso-cli plik danych zawierający tokeny i inne metadane.

Aby wyświetlić tokeny, możesz użyć polecenia podobnego do tego:

get_token -v

To polecenie wyświetla zdekodowane deklaracje tokenów, na przykład:

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
Narzędzia acurl i get_token są dostępne jako „Oprogramowanie” pod umowy regulującej korzystanie przez Ciebie z Google Cloud Platform, w tym z Usługi Szczegółowe warunki są dostępne na stronie https://cloud.google.com/terms/service-terms.