Como usar o get_token

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

O utilitário get_token(1) permite trocar suas credenciais da Apigee por um token de acesso e atualização que pode ser usado para acessar as APIs do Edge. Os tokens também podem ser usados com implementações SAML e LDAP dos fluxos de trabalho do OAuth2.

O get_token permite que você:

  • Consiga um token de acesso ou de atualização.
  • Mostra tokens em stdout para uso em variáveis e comandos.
  • Armazenar tokens no disco.

Você pode adicionar um token válido em suas solicitações para a API Edge e receber um novo quando o seu expirar.

Pré-requisito:antes de usar o get_token, é preciso instalá-lo.

Sintaxe de get_token

O utilitário get_token usa a seguinte sintaxe:

get_token -u USERNAME:PASSWORD [-m MFACODE]

ou

get_token -p passcode

Em que:

Elemento Obrigatório? Descrição
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. Será necessário informar seu nome de usuário ou uma senha na primeira vez que você chamar get_token. Você não precisará passar seu endereço de e-mail novamente até que os tokens de acesso e de atualização expirem. Se você estiver armazenando tokens em cache para mais de um usuário, especifique o nome de usuário em cada chamada.
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. Se omitir a senha, será necessário inseri-la na primeira vez que usar get_token e em qualquer chamada subsequente sem um token de atualização válido. Se você não quiser usar sua senha diretamente no comando, use uma senha de código único em vez da senha.
MFACODE Opcional Um código de autenticação multifator (MFA) temporário de seis dígitos. Esse código será necessário se você usar -u e tiver a autenticação multifator (MFA) ativada. Se omitido, você receberá uma solicitação, exceto no modo de senha. Se a autenticação multifator (MFA) não estiver ativada ou se tiver um fluxo de script, você poderá especificar -m "" para evitar solicitações.
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.

Exemplo:

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

Uma chamada bem-sucedida imprime um token de acesso válido para stdout e armazena os tokens de acesso e de atualização em ~/.sso-cli. Você pode usar esses tokens até que expirem, conforme descrito em Validade do token.

Após a primeira chamada para get_token, não é necessário incluir suas credenciais até que os tokens expirem.

Chamar get_token pela primeira vez

Se você não especificar nenhuma opção na primeira chamada, o get_token vai solicitar o seguinte:

  • Uma senha, se a autenticação for feita com um IdP SAML.
  • Seu nome de usuário, senha e um código MFA temporário, caso contrário.

O exemplo a seguir chama get_token pela primeira vez e usa uma combinação de nome de usuário/senha com um código MFA opcional para autenticação:

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

Adicionar seu token de acesso a uma solicitação

Depois de chamar get_token, use o token de acesso transmitindo-o no cabeçalho Authorization das suas chamadas para a API Edge de várias maneiras. Você pode:

  • Copie o conteúdo da resposta get_token e insira-o diretamente no cabeçalho:
    curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
      -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
  • Combine os comandos para receber o token e adicioná-lo ao cabeçalho:
    token=$(get_token); curl -H "Authorization: Bearer $token" \
      https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Observe que o get_token usa a sintaxe de substituição de comando $(...) para que seja executado.

  • Chame get_token na chamada curl:
    curl -H "Authorization: Bearer $(get_token)" \
      https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Observe que o get_token usa a sintaxe de substituição de comando $(...) para que seja executado.

Esses exemplos de solicitação fornecem detalhes sobre a organização "ahamilton-eval". Para conferir uma lista completa de endpoints da API Edge, consulte a Referência da API Apigee Edge.

Usar get_token com SAML e LDAP

O utilitário get_token pode ser usado com SAML, LDAP ou qualquer outro IdP. O get_token é compatível com o uso de vários URLs de login de SSO e de várias contas. Um único usuário com várias contas será solicitado a especificar o nome de usuário para cada chamada get_token.

Limpar o cache get_token

Use as sinalizações opcionais abaixo para limpar o cache do get_token:

  • --clear-sso-cache

    Limpa o diretório de cache para SSO_LOGIN_URL em $HOME/.sso-cli, descartando qualquer acesso em cache e tokens de atualização do servidor.

  • --clear-all-sso-cache

    Limpa todos os diretórios em $HOME/.sso-cli, descartando todos os tokens em cache.


(1) Copyright 2023 Google LLC
A ferramenta get_token é disponibilizada como "Software" nos termos do contrato que rege o uso do Google Cloud Platform, incluindo os Termos Específicos do Serviço disponíveis em https://cloud.google.com/terms/service-terms.