Uzyskiwanie tokenów przy użyciu usługi Edge OAuth2

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

Możesz użyć usługi Edge OAuth2 do wymiany danych logowania na token dostępu i odświeżania, których następnie używasz do wywoływania punktów końcowych Edge w przepływach pracy OAuth.

Oprócz metod opisanych w tej sekcji możesz też uzyskać tokeny OAuth2 za pomocą narzędzi acurl i get_token.

Ścieżka

POST https://login.apigee.com/oauth/token

Jeśli korzystasz z usługi Edge OAuth2 w organizacji obsługującej SAML w Edge for Public Cloud, musisz uwzględnić w ścieżce nazwę strefy. Na przykład:

POST https://zone.login.apigee.com/oauth/token

Nagłówki żądania

Parametr Wartość
Content-Type "application/x-www-form-urlencoded"
Accept "application/json;charset=utf-8"
Authorization

„Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0”

Możesz wyeksportować tę wartość do zmiennej środowiskowej, aby używać jej ponownie w tych wywołaniach interfejsu API. Na przykład:

export CLIENT_AUTH=ZWRnZWNsaTplZGdlY2xpc2VjcmV0
curl ... -H "Authorization: Basic $CLIENT_AUTH" ...

Parametry formularza

Parametr Wymagana? Wartość
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.
password Opcjonalna. Wymagana jest kombinacja nazwy użytkownika i hasła lub kod dostępu. Hasło do Twojego konta Apigee.
mfa_token Opcjonalny Prawidłowy kod uwierzytelniania wielopoziomowego (MFA) dla Twojego konta. Wymagane tylko wtedy, gdy masz włączone MFA.
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.
grant_type Wymagany

Określa, czy otrzymasz nowy token dostępu, czy odświeżysz istniejący. Prawidłowe wartości to:

  • "password": uzyskaj nowy token dostępu. Gdy grant_type ma wartość „password”, w żądaniu musisz umieścić swoje dane uwierzytelniające Apigee.
  • „refresh_token”: wyślij token odświeżania, aby uzyskać nowy token dostępu. Gdy grant_type ma wartość „refresh_token”, w żądaniu nie musisz podawać danych logowania.
refresh_token Opcjonalnie Token, który przekazujesz, aby uzyskać nowy token dostępu po wygaśnięciu bieżącego. Ten parametr jest wymagany, gdy grant_type ma wartość „refresh_token”.

Przykłady

Uzyskaj nowy token dostępu

Aby uzyskać nowy token dostępu, ustaw grant_type na „password”:

curl -H "Content-Type:application/x-www-form-urlencoded;charset=utf-8" \
      -H "Accept: application/json;charset=utf-8" \
      -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" \
      -X POST https://login.apigee.com/oauth/token \
      -d 'username=ahamilton@example.com&password=mypassw0rd&grant_type=password'

Uzyskaj nowy token dostępu za pomocą MFA

Aby uzyskać nowy token dostępu z włączonym MFA (uwierzytelnianiem wielopoziomowym), pobierz kod MFA, a następnie ustaw wartość parametru mfa_token na jego wartość:

curl -H "Content-Type:application/x-www-form-urlencoded;charset=utf-8" \
  -H "Accept: application/json;charset=utf-8" \
  -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" \
  -X POST https://login.apigee.com/oauth/token?mfa_token=424242 \
  -d 'username=ahamilton@example.com&password=mypassw0rd&grant_type=password'

Odświeżanie tokena dostępu

Aby odświeżyć token dostępu, ustaw grant_type na „refresh_token” i dodaj istniejący token odświeżania jako parametr formularza:

curl -H "Content-Type:application/x-www-form-urlencoded;charset=utf-8"
  -H "Accept: application/json;charset=utf-8" \
  -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" \
  -X POST https://login.apigee.com/oauth/token \
  -d 'grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN'

Przy odświeżaniu tokena dostępu nie musisz podawać danych logowania.

Odpowiedzi

Jeśli proces się powiedzie, otrzymasz token dostępu, token odświeżania i powiązane informacje. Na przykład:

{
  "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOimYyD8IP2IyYS1jNmNiLTQ4NTgtYjZkMS1mZjkyNGFkYTk1YWUiLCJzdWIiOiI0X0KLSNjZlNjM0ZC0zZjlhLTRiNYmFjNi1kYjE2M2M5OGEzOGYiLCJzY29wZSI6WyJzYbmlkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJvYXV0aC5hcHByb3ZhbHMiXSwiY2xpZW50X2lkIjoiZWRnZWNsaSIsImNpZCI6ImVkZ2VjbGkiLCJhenAiOiJlZGdlY2xpIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwidXNlcl9pZCI6IjQ2NmU2MzRkLTNmOWEtNGI0MS1iYWM2LWRiMTYzYzk4YTM4ZiIsIm9yaWdpbiI6InVzZXJncmlkIiwidXNlcl9uYW1lIjoid3dpdG1hbkBhcGlnZWUuY29tIiwiZW1haWwiOiJ3d2l0bWFuQGFwaWdlZS5jb20iLCJhdXRoX3RpbWUiOjE0NzMyNjU4NzcsImFsIjoyLCJyZXZfc2lnIjoiZTc0ZGY0M2QiLCJpYXQiOjE0NzMyNjU4NzcsImV4cCI6MTQ3MzI2NzY3NywiaXNzIjoiaHR0cHM6Ly9sb2dpbi5hcGlnZWUuY29tL29hdXRoL3Rva2VuIiwiemlkIjoidWFhIiwi2ltLm1lIiwib3BlYXVkIjpbImVkZ2VjbGkiLCJzY2ltIiwib3BlbmlkIiwicGFzc3dvcmQiLCJhcHByb3ZhbHMiLCJvYXV0aCJdfQ.AFuevkeGGUGSPED8leyEKaT-xg1xk_VEiKJLEpipVvQBXIqEc9wqcpm-ZuoatA9DhjASRuFSRaHH8Fasx_vBxEBsUNhRY-GTMw7_8fv4yRMOb2AO3WUl_NWwPkC8XRSI1zCMbAZicojsJ1n3OSP487Mu9dl9ByX5A_QfHV2_cj4l9-SD7u6vOdfdbBxbNMAQkfZLrVIEU8myF2dhKnNeMiuoHSHANsQFcx0_BFA1HnSUnVi4RYj1FlTs9SbcPnS1d7t7eVdxWz_q2OFVXNIBMELAvvM0WhXPYTW3Osve3UvvUs6ekGs-K-RCPSok-4-NJbdCDpZQQTgqHsrf77NTsw",
  "token_type": "bearer",
  "refresh_token": "eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiJmZTIIMZWI0ZS00YzFmLTRjOTEtYmY5Mi1mMzZLEMzNjZhMDctciIsInN1YiI6IjQ2NmU2MzRkLTNmOWEtNGI0MS1iY17LLWRiMTYzYzk4YTM4ZiIsInNjb3BlIjpbInNjaW0ubWUiLCJvcGVuaWQiLCJwYXNzd29yZC53cml0ZSIsImFwcHJvdmFscy5tZSIsIm9hdXRoLmFwcHJvdmFscyJdLCJpYXQiOjE0NzMyNjU4NzcsImV4cCI6MTQ3NsaSIsImNsaWVudF9pZCI6ImVkZ2VjbGkiLCJpc3MiOiJodHRwczovL2xvZ2luLmFwaWdlZS5jb20vb2F1dGgvdG9rZW4iLCJ6aWQiOiJ1YWEiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiJ3d2l0bWFuQGFwaWdlZS5jbMzM1MDQ3NywiY2lkIjoiZWRnZW20iLCJvcmlnaW4iOiJ1c2VyZ3JpZCIsInVzZXJfaWQiOiI0NjZlNjM0ZC0zZjlhLTRiNDEtYmFjNi1kYjE2M2M5OGEzOGYiLCJhbCI6MiwicmV2X3NpZyI6ImU3NGRmNDNkIiwiYXVkIjpbImVkZ2VjbGkiLCJzY2ltIiwib3BlbmlkIiwicGFzc3dvcmQiLCJhcHByb3ZhbHMiLCJvYXV0aCJdfQ.kBP5AkbRS7Tnp-5VAfTLVfkUbUer4gFEU6A7g202KTKiXbqTwPSmOIGFTK12XevVPQYmAaSMFAnempWKfY7sjaY7HC7q3mGl53_A18cnkKhtNq15wCnyMom_bX_MYLW1RQPFytJ6akSJ-JkoPFU0x_FQg1JIvub1A8eqQxcR0KP-QRCxYAS4HTjH80vDIxHNt1tg7clmpa3RlHri0dlPVVsSpTXXhkpXRg5QbiWMrpkACSV22c0x0KiNu7vx5A520VOCO7hQ7IzmVIcSWcRqI97L7WdCjH_q4105bs2qmW73670MC0UGiJ9t5B1S1cxwqpUEd-NAuCsY8SVn6eWzbA",
  "expires_in": 1799,
  "scope": "scim.me openid password.write approvals.me oauth.approvals",
  "jti": "9bf2cb2a-c6cb-4858-b6d1-ff924ada95ae"
}

Zapisz wartości odpowiedzi:

  • Używaj access_token w wywołaniach interfejsu Edge API
  • Użyj refresh_token, gdy token dostępu wygaśnie i trzeba będzie go odświeżyć

Jeśli otrzymasz odpowiedź podobną do tej:

{
  "error": "unauthorized",
  "error_description": "Bad credentials"
}

Pamiętaj, aby w żądaniu w nagłówku Authorization użyć dokładnie tego samego ciągu znaków („ZWRnZWNsaTplZGdlY2xpc2VjcmV0”) w żądaniu.