Korzystanie z get_token

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

Narzędzie get_token⁽¹⁾ umożliwia wymianę danych logowania Apigee na token dostępu i odświeżenia, którego możesz użyć w celu uzyskania dostępu do interfejsów Edge API. Tokenów można też używać w implementacjach SAML i LDAP przepływów pracy OAuth2.

get_token umożliwia:

• Uzyskaj token dostępu lub token odświeżania.
• Drukuj tokeny w stdout, aby używać ich w zmiennych i poleceniach.
• Przechowuj tokeny 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.

Warunek wstępny: aby używać usługi get_token, musisz ją zainstalować.

Składnia get_token

Narzędzie get_token używa następującej składni:

get_token -u USERNAME:PASSWORD [-m MFACODE]

lub

get_token -p passcode

Gdzie:

Element	Wymagana?	Opis
USERNAME	Opcjonalna. Wymagana jest kombinacja nazwy użytkownika i hasła lub kod 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ć nazwę użytkownika lub kod dostępu. Nie musisz ponownie przekazywać swojego adresu e-mail, dopóki tokeny dostępu i odświeżenia nie wygasną. Jeśli przechowujesz tokeny w pamięci podręcznej dla więcej niż 1 użytkownika, nazwę użytkownika musisz podawać w każdym wywołaniu.
PASSWORD	Opcjonalna. Wymagana jest kombinacja nazwy użytkownika i hasła lub kod dostępu.	Hasło do Twojego konta Apigee. Jeśli pominiesz hasło, zobaczysz prośbę o jego podanie przy pierwszym użyciu get_token oraz przy kolejnych wywołaniach bez prawidłowego tokena odświeżania. Jeśli nie chcesz używać hasła bezpośrednio w poleceniu, możesz zamiast hasła podać jednorazowy kod dostępu.
MFACODE	Opcjonalny	Tymczasowy 6-cyfrowy kod uwierzytelniania wielopoziomowego (MFA). Ten kod jest wymagany, jeśli korzystasz z usługi -u i masz włączone MFA. W przypadku pominięcia zostanie wyświetlony monit (chyba że w trybie dostępu do hasła). Jeśli nie masz włączonego MFA lub korzystasz z procesu opartego na skryptach, możesz określić -m "", aby unikać monitów.
PASSCODE	Opcjonalna. Wymagana jest kombinacja nazwy użytkownika i hasła lub kod dostępu.	Jednorazowy kod dostępu, którego możesz używać zamiast hasła. Kod dostępu jest wymagany podczas uwierzytelniania u dostawcy tożsamości SAML. Kod może służyć do uwierzytelniania u 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 wyświetla prawidłowy token dostępu do usługi stdout oraz zapisuje zarówno tokeny dostępu, jak i tokeny odświeżania w ~/.sso-cli. Możesz z nich korzystać do momentu ich wygaśnięcia, zgodnie z opisem w sekcji Wygaśnięcie tokena.

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

Wywołanie get_token po raz pierwszy

Jeśli w pierwszym wywołaniu nie określisz żadnych opcji, get_token poprosi Cię o:

• kod dostępu (w przypadku uwierzytelniania przy użyciu dostawcy tożsamości SAML).
• Twoja nazwa użytkownika, hasło i tymczasowy kod MFA.

Poniższy przykład wywołuje funkcję get_token po raz pierwszy i do uwierzytelniania używa kombinacji nazwy użytkownika i hasła z opcjonalnym kodem MFA:

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 wywołaniu get_token możesz użyć tokena dostępu, przekazując go w nagłówku Authorization w wywołaniach do interfejsu Edge API na kilka sposobów. Możesz:

• Skopiuj zawartość odpowiedzi get_token i wstaw ją bezpośrednio do nagłówka:

  curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
    -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"

• Połącz polecenia, aby uzyskać token i dodaj 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ń $(...).

• Zadzwoń na numer get_token w trakcie rozmowy 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 zastępowania poleceń $(...).

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

Używanie get_token z SAML i LDAP

Narzędzie get_token może być używane z protokołami SAML, LDAP i dowolnym innym podstawowym dostawcą tożsamości. get_token umożliwia korzystanie z wielu adresów URL logowania jednokrotnego i wielu kont. W przypadku każdego wywołania get_token dla pojedynczego użytkownika z wieloma kontami będzie pojawiać się prośba o podanie nazwy użytkownika.

Wyczyść pamięć podręczną 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 serwera SSO_LOGIN_URL w jednostce organizacyjnej $HOME/.sso-cli, odrzucając wszystkie zapisane w pamięci podręcznej tokeny dostępu i odświeżania serwera.

• --clear-all-sso-cache

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

---

⁽¹⁾ Prawa autorskie 2023 Google LLC
Narzędzie get_token jest dostępne 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.

---