Informacje o parametrach acurl i get_token

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Apigee udostępnia te wygodne narzędzia do generowania i przekazywania tokenów dostępu OAuth2 i odświeżania. Używasz tych tokenów do uwierzytelniania się w wywołaniach interfejsu Edge API za pomocą OAuth (w tym SAML i przepływów pracy LDAP):

  • acurl(1): zapewnia wygodną otoczkę wokół standardowego curl polecenia. Tworzy żądania HTTP do interfejsu Edge API, pobiera tokeny dostępu i odświeżania z get_token oraz przekazuje token dostępu do interfejsu Edge API.
  • get_token(1): wymienia dane logowania Apigee na tokeny dostępu i odświeżania, których możesz używać do wywoływania interfejsu Edge API.

Oba te narzędzia wymieniają dane logowania do konta Apigee (nazwę użytkownika i hasło lub kod dostępu) na tokeny OAuth2.

Tokeny utworzone przez narzędzia Apigee są zgodne ze specyfikacją OAuth 2.0 Authorization Framework.

Używanie narzędzi Apigee do pobierania tokenów lub uzyskiwania dostępu do serwera uwierzytelniania w przypadku interfejsów Edge API jest opcjonalne. Możesz zaimplementować własne schematy generowania tokenów dostępu OAuth2 i wysyłać je w żądaniach do interfejsu Edge API.

Instalowanie acurl i get_token

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

Aby zainstalować acurl i get_token:

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

    Opcja -b określa lokalizację plików wykonywalnych. Jeśli nie określisz tej opcji, skrypt instalacyjny zainstaluje narzędzia w katalogu /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 tokenu

acurl i get_token generują tokeny o tych czasach trwania:

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

Dzięki temu po pomyślnym wywołaniu interfejsu API za pomocą acurl lub get_token, możesz nadal używać pary tokenów przez 30 dni. Po wygaśnięciu musisz ponownie wpisać dane logowania i uzyskać nowe tokeny.

Ustawianie punktu końcowego logowania jednokrotnego

Zanim wykonasz pierwsze wywołanie, musisz ustawić punkt końcowy serwera autoryzacji dla interfejsu Edge API, którego chcesz używać z acurl i get_token.

W terminalu ustaw zmienną środowiskową SSO_LOGIN_URL na punkt końcowy serwera autoryzacji. 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
  • W przypadku klientów Private Cloud skontaktuj się z administratorem, aby uzyskać odpowiedni punkt końcowy logowania jednokrotnego.

Używanie jednorazowego kodu dostępu (wymagane w przypadku SAML)

Gdy wywołujesz interfejs API za pomocą acurl lub get_token, musisz uwierzytelnić się w narzędziu, aby otrzymać parę tokenów. Możesz to zrobić, podając nazwę użytkownika, hasło i kod MFA do konta Apigee. Jeśli jednak używasz dostawcy tożsamości SAML lub nie chcesz używać hasła, możesz zamiast tego 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
    • W przypadku klientów Private Cloud skontaktuj się z administratorem, aby uzyskać odpowiedni punkt końcowy 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ż kod dostępu, jak w tym przykładzie: 
    get_token -p 1a2b3c

Wyświetlanie tokenów

Gdy pomyślnie wykonasz acurl lub get_token, narzędzia utworzą plik danych w ~/.sso-cli, który zawiera tokeny i inne metadane.

Aby wyświetlić tokeny, możesz użyć polecenia takiego jak to:

get_token -v

To polecenie wyświetla zdekodowane deklaracje tokena, 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ą udostępniane jako "Oprogramowanie" zgodnie z umową regulującą korzystanie przez Ciebie z Google Cloud Platform, w tym ze Szczegółowymi warunkami korzystania z usługi dostępnymi na stronie https://cloud.google.com/terms/service-terms.