Esta página foi traduzida pela API Cloud Translation.

Como usar o get_token

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

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

get_token permite que você:

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

Depois disso, é possível adicionar um token válido nas solicitações à API Edge e receber um novo quando o seu expirar.

Pré-requisito: antes de usar get_token, você precisa: instale-o.

Sintaxe de get_token

O utilitário get_token usa a seguinte sintaxe:

get_token -u USERNAME:PASSWORD [-m MFACODE]

get_token -p passcode

Em que:

Elemento	Obrigatório?	Descrição
`USERNAME`	Opcional. É necessário usar 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 à conta da Apigee. É necessário passar seu nome de usuário ou senha na primeira vez que chamar `get_token`. Você não precisa enviar seu e-mail insira o endereço novamente até que os tokens de acesso e atualização expirem. Se você armazenar tokens em cache para mais de um usuário, especifique seu nome de usuário em cada chamada.
`PASSWORD`	Opcional. É necessário usar uma combinação de nome de usuário e senha ou uma senha.	A senha da sua conta da Apigee. Se você omitir a senha, será solicitado insira-o na primeira vez que usar `get_token` e em todas as chamadas subsequentes sem um valor válido token de atualização. Se não quiser usar sua senha diretamente no comando, use um uma senha de uso único em vez da sua senha.
`MFACODE`	Opcional	Uma autenticação multifator temporária de seis dígitos de autenticação (MFA). Esse código será necessário se você usar `-u` e a MFA estiver ativada. Você receberá uma notificação se ela for omitida (a menos que esteja no modo de senha). Se a MFA não estiver ativada, Se você tem um fluxo com script, é possível especificar `-m ""` para evitar solicitações.
`PASSCODE`	Opcional. É necessário usar uma combinação de nome de usuário e senha ou uma senha.	Uma senha única que você pode usar no lugar de uma senha. Uma senha é necessária para 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 atualização e acesso em ~/.sso-cli. Você pode usar esses tokens até conforme descrito em Validade do token.

Depois da sua primeira chamada para get_token, você não precisa incluir o as 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 estiver sendo feita com um provedor de identidade (IDP, na sigla em inglês) 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 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 get_token usa a sintaxe de substituição de comando $(...). Portanto, que ele 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 get_token usa a sintaxe de substituição de comando $(...). Portanto, que ele seja executado.

Esses exemplos de solicitações obtêm detalhes sobre o "ahamilton-eval" organização. Para acessar 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 permite o uso de vários URLs de login 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 de get_token.

Limpar o cache get_token

É possível usar as seguintes sinalizações opcionais 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 todos os tokens de acesso e atualização armazenados em cache para o servidor.
```
--clear-all-sso-cache
```
Limpa todos os diretórios em $HOME/.sso-cli, descartando todos os tokens em cache.

⁽¹⁾ Copyright 2023 Google LLC
A ferramenta get_token é disponibilizada como "Software" na seção contrato que rege seu uso do Google Cloud Platform, incluindo o Serviço Termos específicos disponíveis em https://cloud.google.com/terms/service-terms.