Como usar o serviço do Edge OAuth2 para receber tokens

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

É possível usar o serviço do Edge OAuth2 para trocar suas credenciais por um token de acesso e atualização usado para chamar endpoints do Edge nos fluxos de trabalho do OAuth.

Além das técnicas descritas nesta seção, também é possível usar os utilitários acurl e get_token para receber tokens OAuth2.

Caminho

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

Se você estiver acessando o serviço OAuth2 do Edge de uma organização ativada para SAML no Edge para nuvem pública, precisará incluir o nome da zona no seu caminho. Exemplo:

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

Cabeçalhos de solicitação

Parâmetro Valor
Content-Type "application/x-www-form-urlencoded"
Accept “application/json;charset=utf-8”
Authorization

"ZWRnZWNsaTplZGdlY2xpc2VjcmV0" básico

É possível exportar esse valor para uma variável de ambiente para que possa ser reutilizado nessas chamadas de API. Exemplo:

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

Parâmetros do formulário

Parâmetro Obrigatório? Valor
username Opcional. É necessário ter uma combinação de nome de usuário e senha ou uma senha. Seu nome de usuário da Apigee, que geralmente é o endereço de e-mail associado à sua conta da Apigee.
password Opcional. É necessário ter uma combinação de nome de usuário e senha ou uma senha. A senha da sua conta da Apigee.
mfa_token Opcional Um código de autenticação multifator (MFA) válido para sua conta. Obrigatório apenas se você tiver a MFA ativada.
passcode Opcional. É necessário ter uma combinação de nome de usuário e senha ou uma senha. Uma senha única que pode ser usada no lugar de uma senha. Uma senha é necessária ao autenticar com um IDP SAML e pode ser usada para autenticar com um IdP LDAP.
grant_type Obrigatório

Determina se você recebe um novo token de acesso ou atualiza o atual. Os valores válidos são:

  • "password": receba um novo token de acesso. Quando grant_type for "senha", você vai precisar incluir suas credenciais da Apigee na solicitação.
  • "refresh_token": enviar um token de atualização para receber um novo token de acesso. Quando grant_type é "refresh_token", não é necessário incluir suas credenciais na solicitação.
refresh_token Opcional O token que você transmite para receber um novo token de acesso quando o token de acesso atual expirar. Esse parâmetro é obrigatório quando grant_type é "refresh_token".

Exemplos

Receber um novo token de acesso

Para receber um novo token de acesso, defina grant_type como "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'

Receber um novo token de acesso com a MFA

Para receber um novo token de acesso com a autenticação multifator (MFA) ativada, receba o código de MFA e defina o parâmetro mfa_token como o valor dele:

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'

Atualizar um token de acesso

Para atualizar um token de acesso, defina grant_type como "refresh_token" e adicione seu token de atualização atual como um parâmetro de formulário:

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'

Observe que não é necessário passar suas credenciais ao atualizar o token de acesso.

Respostas

Em caso de êxito, você receberá um token de acesso, um token de atualização e as informações relacionadas. Por exemplo:

{
  "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"
}

Salve os valores de resposta:

  • Usar o access_token em chamadas para a API Edge
  • Use o refresh_token quando seu token de acesso expirar e você precisar atualizá-lo.

Se você receber uma resposta como esta:

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

Use a string exata acima ("ZWRnZWNsaTplZGdlY2xpc2VjcmV0") para o cabeçalho Authorization na sua solicitação.