Korzystanie z get_token

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

Narzędzie get_token(1) umożliwia wymianę danych logowania Apigee na token dostępu i token odświeżania, których możesz używać do uzyskiwania dostępu do interfejsów API Edge. Tokeny można też używać w implementacjach SAML i LDAP przepływów pracy OAuth2.

get_token umożliwia:

  • uzyskanie tokena dostępu lub tokena odświeżania;
  • drukowanie tokenów w stdout do użycia w zmiennych i poleceniach;
  • przechowywanie tokenów na dysku.

Następnie możesz dodać prawidłowy token w żądaniach do interfejsu Edge API i uzyskać nowy token, gdy Twój wygaśnie.

Wymaganie wstępne: zanim zaczniesz używać get_token, musisz go zainstalować.

Składnia get_token

Narzędzie get_token używa tej składni:

get_token -u USERNAME:PASSWORD [-m MFACODE]

lub

get_token -p passcode

Gdzie:

Element Wymagany? Opis
USERNAME Opcjonalnie. Wymagane jest połączenie nazwy użytkownika i hasła lub kod dostępu. Twoja nazwa użytkownika Apigee, która zwykle jest adresem e-mail powiązanym z Twoim kontem Apigee. Przy pierwszym wywołaniu get_token musisz podać nazwę użytkownika lub kod dostępu. Nie musisz ponownie podawać adresu e-mail dopóki nie wygasną tokeny dostępu i tokeny odświeżania. Jeśli przechowujesz tokeny dla więcej niż 1 użytkownika, musisz podać nazwę użytkownika w każdym wywołaniu.
PASSWORD Opcjonalnie. Wymagane jest połączenie nazwy użytkownika i hasła lub kod dostępu. Hasło do Twojego konta Apigee. Jeśli pominiesz hasło, pojawi się prośba o jego podanie przy pierwszym użyciu get_token i przy każdym kolejnym wywołaniu bez prawidłowego tokena odświeżania. Jeśli nie chcesz używać hasła bezpośrednio w poleceniu, możesz zamiast niego użyć a jednorazowego kodu dostępu.
MFACODE Opcjonalnie Tymczasowy 6-cyfrowy uwierzytelniania wielopoziomowego (MFA) kod. Ten kod jest wymagany, jeśli używasz -u i masz włączone MFA. Jeśli go pominiesz, pojawi się prośba o jego podanie (chyba że używasz trybu kodu dostępu). Jeśli nie masz włączonego MFA, lub masz skryptowy przepływ pracy, możesz określić -m "" , aby uniknąć wyświetlania próśb.
PASSCODE Opcjonalnie. Wymagane jest połączenie nazwy użytkownika i hasła lub kod dostępu. Jednorazowy kod dostępu, którego możesz użyć zamiast hasła. Kod dostępu jest wymagany podczas uwierzytelniania za pomocą dostawcy tożsamości SAML i może być używany do uwierzytelniania za pomocą dostawcy tożsamości LDAP.

Na przykład:

get_token
get_token -u ahamilton@apigee.com:mypassw0rd -m 424242
get_token -p mypass

Pomyślne wywołanie powoduje wydrukowanie prawidłowego tokena dostępu w stdout i zapisanie tokena dostępu oraz tokena odświeżania w ~/.sso-cli. Możesz używać tych tokenów do momentu ich wygaśnięcia, zgodnie z opisem w sekcji Wygaśnięcie tokena.

Po pierwszym pomyślnym wywołaniu get_token nie musisz podawać swoich danych logowania, dopóki tokeny nie wygasną.

Pierwsze wywołanie get_token

Jeśli w pierwszym wywołaniu nie określisz żadnych opcji, get_token wyświetli prośbę o podanie tych informacji:

  • Kod dostępu, jeśli uwierzytelnianie odbywa się za pomocą dostawcy tożsamości SAML.
  • W przeciwnym razie – nazwa użytkownika, hasło i tymczasowy kod MFA.

Ten przykład pokazuje pierwsze wywołanie get_token i użycie kombinacji nazwy użytkownika i hasła z opcjonalnym kodem MFA do uwierzytelniania:

get_token
Enter username:
ahamilton@apigee.com
Enter the password for user 'ahamilton@apigee.com':
[hidden input]
Enter the six-digit code if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:
123456

ey42bGciOiJSUzI1NiJ9.eyJqdGkiOiJhM2YwNjA5ZC1lZTIxLTQ1YjAtOGQyMi04MTQ0MTYxNjNhNTMiLCJzdWIiOiIyZDFl
  <snip>
VlLmNvbSIsInppZCI6InVhYSIsImF1ZCI6WyJlZGdlY2xpIiwic2NpbSIsIm9wZW5pZCIsInBhc3N3b3JkIiwiYXBwcm54242

Dodawanie tokena dostępu do żądania

Po pomyślnym wywołaniu get_token możesz użyć tokena dostępu, przekazując go na kilka sposobów w nagłówku Authorization wywołań interfejsu Edge API. Możesz:

  • skopiować zawartość odpowiedzi get_token i wstawić ją bezpośrednio do nagłówka: 
    curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
  -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
  • połączyć polecenia, aby uzyskać token i dodać go do nagłówka: 
    token=$(get_token); curl -H "Authorization: Bearer $token" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Pamiętaj, że get_token używa składni podstawiania poleceń $(...) tak, aby można było je wykonać.

  • wywołać get_token w wywołaniu curl: 
    curl -H "Authorization: Bearer $(get_token)" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Pamiętaj, że get_token używa składni podstawiania poleceń $(...) tak, aby można było je wykonać.

Te przykładowe żądania pobierają szczegóły organizacji „ahamilton-eval”. Pełną listę punktów końcowych interfejsu Edge API znajdziesz w dokumentacji Apigee Edge API.

Używanie get_token z SAML i LDAP

Narzędzie get_token można używać z SAML, LDAP lub dowolnym innym dostawcą tożsamości. get_token obsługuje używanie wielu adresów URL logowania jednokrotnego i wielu kont. Użytkownik z kilkoma kontami będzie musiał podać nazwę użytkownika w każdym get_token wywołaniu.

Czyszczenie pamięci podręcznej get_token

Aby wyczyścić pamięć podręczną get_token, możesz użyć tych opcjonalnych flag:

  • --clear-sso-cache

    Czyści katalog pamięci podręcznej dla SSO_LOGIN_URL w $HOME/.sso-cli , odrzucając wszystkie tokeny dostępu i tokeny odświeżania w pamięci podręcznej serwera.

  • --clear-all-sso-cache

    Czyści wszystkie katalogi w $HOME/.sso-cli, odrzucając wszystkie tokeny w pamięci podręcznej.

(1) Copyright 2023 Google LLC
Narzędzie get_token jest 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.