Korzystanie z get_token

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

Narzędzie get_token(1) umożliwia wymianę danych logowania do Apigee w celu uzyskania dostępu i odśwież token, aby umożliwić dostęp do interfejsów Edge API. Tokenów można też używać z SAML. i implementacji LDAP dla przepływów pracy OAuth2.

get_token umożliwia:

  • Uzyskaj token dostępu lub token odświeżania.
  • Wydrukuj tokeny w usłudze stdout, aby wykorzystać je w zmiennych i poleceniach.
  • Przechowuj tokeny na dysku.

Następnie możesz dodać prawidłowy token do żądań do interfejsu Edge API i uzyskać nowy token, gdy skończy się ważność Twojego tokena.

Warunek wstępny: zanim zaczniesz używać get_token, musisz zainstaluj ją.

składnia get_token

Narzędzie get_token korzysta z tej składni:

get_token -u USERNAME:PASSWORD [-m MFACODE]

lub

get_token -p passcode

Gdzie:

Element Wymagany? Opis
USERNAME Opcjonalna. Wymagane jest podanie kombinacji nazwy użytkownika i hasła lub kodu dostępu. Twoja nazwa użytkownika Apigee, czyli zwykle adres e-mail powiązany z Twoim kontem Apigee. Przy pierwszym połączeniu z numerem get_token musisz podać swoją nazwę użytkownika lub kod dostępu. Nie musisz przekazywać swojej poczty e-mail. do czasu upływu ważności tokenów dostępu i odświeżania. Jeśli buforujesz tokeny dla więcej niż jednego użytkownika musisz podać swoją nazwę użytkownika w każdym wywołaniu.
PASSWORD Opcjonalna. Wymagane jest podanie kombinacji nazwy użytkownika i hasła lub kodu dostępu. Hasło do konta Apigee. Jeśli pominiesz hasło, pojawi się prośba o jego podanie przy pierwszym użyciu get_token oraz 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 użyć polecenia jednorazowego kodu dostępu zamiast hasła.
MFACODE Opcjonalny Tymczasowy 6-cyfrowy wielopoziomowy wieloskładnikowy (MFA). Ten kod jest wymagany, jeśli korzystasz z usługi -u i masz włączone MFA. Jeśli zostanie pominięte (chyba że w trybie kodu dostępu) pojawi się odpowiedni komunikat. Jeśli nie masz włączonego MFA, lub używasz skryptu, możesz określić -m "", aby uniknąć próśb.
PASSCODE Opcjonalna. Wymagane jest podanie kombinacji nazwy użytkownika i hasła lub kodu dostępu. jednorazowego kodu dostępu, którego możesz użyć zamiast hasła. Kod dostępu jest wymagany podczas uwierzytelniania przy użyciu dostawcy tożsamości SAML i może być używany aby uwierzytelnić się u dostawcy tożsamości LDAP.

Na przykład:

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

Udane wywołanie generuje prawidłowy token dostępu do stdout i przechowuje zarówno tokeny dostępu i odświeżanie ich w ~/.sso-cli. Możesz używać tych tokenów, dopóki nie zgodnie z opisem w sekcji Wygaśnięcie tokena.

Po pierwszym udanym wywołaniu get_token nie musisz dodawać danych logowania do czasu wygaśnięcia tokenów.

Po raz pierwszy wywołaj get_token

Jeśli podczas pierwszego wywołania nie określisz żadnych opcji, get_token poprosi Cię o następujące:

  • Hasło do uwierzytelniania przy użyciu dostawcy tożsamości SAML.
  • Nazwa użytkownika, hasło i tymczasowy kod MFA.

W tym przykładzie po raz pierwszy użyto wywołania get_token i użycie kombinacja nazwy użytkownika i hasła z opcjonalnym kodem MFA na potrzeby 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 interfejsu get_token możesz używać tokena dostępu, przekazując go w nagłówku Authorization wywołań interfejsu Edge API na kilka sposobów. Możesz:

  • Skopiuj treść odpowiedzi get_token i wstaw ją bezpośrednio w polu nagłówek: 
    curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
  -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
  • Połącz 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 zastępowania poleceń $(...), aby można było ją wykonać.

  • Zadzwoń do użytkownika get_token w ramach rozmowy curl: 
    curl -H "Authorization: Bearer $(get_token)" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Pamiętaj, że funkcja get_token używa składni zastępowania poleceń $(...), więc że jest ona wykonywana.

Te przykładowe żądania uzyskują szczegółowe informacje o obiekcie „ahamilton-eval” Twojej organizacji. Pełną listę punktów końcowych interfejsu Edge API znajdziesz w dokumentacji interfejsu API Apigee.

Używanie get_token z SAML i LDAP

Narzędzia get_token można używać z protokołem SAML, LDAP lub dowolnym innym bazowym dostawcą tożsamości. get_token umożliwia korzystanie z wielu adresów URL logowania jednokrotnego i wielu kont. Pojedynczy użytkownik mający kilka kont zostanie poproszony o podanie nazwy użytkownika za każde połączenie get_token.

Wyczyść pamięć podręczną get_token

Do czyszczenia pamięci podręcznej get_token możesz użyć tych opcjonalnych flag:

  • --clear-sso-cache

    Czyści katalog pamięci podręcznej przeglądarki SSO_LOGIN_URL w okresie $HOME/.sso-cli odrzucenie wszystkich tokenów dostępu w pamięci podręcznej i tokenów odświeżania serwera.

  • --clear-all-sso-cache

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

(1) Prawa autorskie 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.