Informacje o parametrach acurl i get_token

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Apigee udostępnia poniższe wygodne narzędzia do generowania i przekazywania dostępu OAuth2 oraz tokenów odświeżania. Tych tokenów możesz używać do uwierzytelniania się w wywołaniach interfejsu Edge API za pomocą OAuth (w tym przepływów pracy SAML i LDAP):

  • acurl(1): zapewnia wygodny kod wokół standardowego polecenia curl. Konstruuje żądania HTTP wysyłane do interfejsu Edge API, uzyskuje tokeny dostępu i odświeżania z platformy get_token oraz przekazuje token dostępu do interfejsu Edge API.
  • get_token(1): wymienia dane logowania Apigee na potrzeby dostępu i odświeża tokeny, których możesz używać do wywoływania Edge API.

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

Tokeny utworzone przez narzędzia Apigee są zgodne ze specyfikacją protokołu OAuth 2.0.

Korzystanie z narzędzi Apigee do uzyskiwania tokenów lub uzyskiwania dostępu do serwera uwierzytelniania dla interfejsów API Edge jest opcjonalne. Możesz wdrożyć własne schematy, aby generować tokeny dostępu OAuth2 i wysyłać je w żądaniach do interfejsu Edge API.

Zainstaluj tagi acurl i get_token

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

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 instalacji: 
    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 wybierzesz tej opcji, skrypt instalacji zainstaluje narzędzia w /usr/local/bin.

  5. Przetestuj instalacje: 
        acurl -h
    get_token -h

    Jeśli instalacja się powiedzie, te polecenia zwracają tekst pomocy dla narzędzi.

Wygaśnięcie tokena

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.

W związku z tym po wywołaniu interfejsu API za pomocą acurl lub get_token możesz używać tej pary tokenów przez 30 dni. Po wygaśnięciu okresu logowania musisz ponownie wpisać swoje dane uwierzytelniające i uzyskać 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ó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:

  • Klienci Cloud bez strefy: 
    export SSO_LOGIN_URL=https://login.apigee.com
  • W przypadku klientów Cloud z określoną strefą: 
    export SSO_LOGIN_URL=https://zone_name.login.apigee.com
  • Jeśli korzystasz z 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 wykonujesz wywołanie interfejsu API za pomocą acurl lub get_token, musisz uwierzytelnić się w tym narzędziu, aby otrzymać parę tokenów. Aby to zrobić, podaj nazwę użytkownika, hasło i kod MFA do swojego konta Apigee. Jeśli jednak korzystasz z dostawcy tożsamości SAML lub nie chcesz używać hasła, możesz zamiast niego użyć jednorazowego kodu dostępu.

Aby otrzymać jednorazowy kod dostępu:

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

Wyświetl swoje tokeny

Po wykonaniu acurl lub get_token narzędzia tworzą w ~/.sso-cli plik danych zawierający tokeny i inne metadane.

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

get_token -v

To polecenie wyświetla zdekodowane żądania 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) Prawa autorskie 2023 Google LLC
Narzędzia acurl i get_token są udostępniane jako „Oprogramowanie” w ramach umowy regulującej korzystanie z Google Cloud Platform, w tym ze Szczegółowymi warunkami korzystania z usługi dostępnymi na https://cloud.google.com/terms/service-terms.