Esta é a documentação do Apigee Edge.
Acesse
Documentação da Apigee X. informações
A Apigee oferece os utilitários de conveniência a seguir para gerar e transmitir acesso ao OAuth2. e tokens de atualização. Use esses tokens para se autenticar na API Edge chamadas com o OAuth (incluindo SAML e LDAP:
acurl
(1): fornece um wrapper de conveniência em torno de umcurl
. cria solicitações HTTP para a borda; API, recebe tokens de acesso e atualização deget_token
e transmite o token de acesso para a borda API.get_token
(1): troca suas credenciais da Apigee por acesso e tokens de atualização que podem ser usados para chamar a API Edge.
Os dois utilitários trocam as credenciais da sua conta da Apigee (nome de usuário e senha ou senha) por Tokens OAuth2.
Os tokens criados pelos utilitários da Apigee estão em conformidade com a Framework de autorização do OAuth 2.0 especificação.
O uso dos utilitários da Apigee para receber tokens ou acessar o servidor de autenticação para as APIs Edge é opcional. Implemente seus próprios esquemas para gerar tokens de acesso OAuth2 e enviá-los nas solicitações ao Edge API.
Instalar acurl e get_token
A Apigee fornece um arquivo ZIP contendo acurl
(1), get_token
(1) e
um script de instalação.
Para instalar acurl
e get_token
:
- Crie um diretório de instalação na sua máquina ou use o diretório
usr/local/bin
padrão. - Faça o download do arquivo ZIP de instalação na Apigee:
curl https://login.apigee.com/resources/scripts/sso-cli/ssocli-bundle.zip -O
- Descompacte o arquivo salvo.
- Execute o script de instalação:
sudo ./install -b /usr/local/bin
A opção
-b
especifica o local dos arquivos executáveis. Se você não especificar essa opção, o script de instalação instalará os utilitários em/usr/local/bin
. - Teste as instalações:
acurl -h
get_token -h
Se a instalação for bem-sucedida, esses comandos retornarão texto de ajuda para os utilitários.
Expiração do token
acurl
e get_token
geram tokens com as seguintes durações:
- Os tokens de acesso expiram em 12 horas.
- Os tokens de atualização expiram em 30 dias.
Por isso, depois de fazer uma chamada de API com acurl
ou get_token
,
é possível continuar usando o par por 30 dias. Após a expiração, você deve inserir novamente seu
credenciais e obter novos tokens.
Configurar o endpoint de SSO
Antes de fazer a primeira chamada, defina o endpoint do servidor de autorização para a API Edge que você
quer usar com acurl
e get_token
.
No terminal, defina a variável de ambiente SSO_LOGIN_URL
como sua autorização
endpoint do servidor da Web. Exemplo:
- Para clientes do Cloud sem zona:
export SSO_LOGIN_URL=https://login.apigee.com
- Para clientes do Cloud com zona:
export SSO_LOGIN_URL=https://zone_name.login.apigee.com
- Para clientes da nuvem privada, entre em contato com o administrador do endpoint de SSO apropriado.
Usar uma senha única (exigida para SAML)
Ao fazer uma chamada de API com acurl
ou get_token
, é necessário autenticar
você ao
para receber um par de tokens. Para fazer isso, transmita seu código da Apigee
nome de usuário, senha e um código MFA. No entanto, se você estiver usando um IdP SAML ou não quiser
para usar sua senha, você pode receber uma senha de código de uso único em seu lugar.
Para receber uma senha única:
- Digite o seguinte URL em um navegador:
- Para clientes do Cloud sem zona:
https://login.apigee.com/passcode
- Para clientes do Cloud com zona:
https://zone_name.login.apigee.com/passcode
- Para clientes da nuvem privada, entre em contato com o administrador do endpoint de SSO apropriado.
- Para clientes do Cloud sem zona:
- Faça login na sua conta da Apigee.
- Copie a senha de seis caracteres.
- Use
acurl
ouget_token
com a opção-p
e transmita o senha, como no exemplo a seguir:get_token -p 1a2b3c
Ver seus tokens
Quando você executa acurl
ou get_token
, os utilitários
Criar um arquivo de dados em ~/.sso-cli
que contenha os tokens e outros metadados.
Para ver os tokens, use um comando como este:
get_token -v
Esse comando exibe as declarações de token decodificadas, por exemplo:
Decoded token claims: { "jti": "8018507e-9f34-4a90-bf97-ff226a06b19b", "sub": "858217a9-01a1-4111-8525-75ca555f5d5c", "scope": [ "scim.emails.read", "scim.me", "openid", "password.write", "approvals.me", "scim.ids.read", "oauth.approvals" ], "client_id": "edgecli", "cid": "edgecli", "azp": "edgecli", "grant_type": "password", "user_id": "858217a9-01a1-4111-8525-75ca555f5d5c", "origin": "usergrid", "user_name": "myusername@google.com", "email": "myusername@google.com", "auth_time": 1597444772, "al": 0, "rev_sig": "6271c527", "iat": 1597444772, "exp": 1597487972, "iss": "https://login.apigee.com", "zid": "uaa", "aud": [ "edgecli", "scim.emails", "scim", "openid", "password", "approvals", "scim.ids", "oauth" ] } Current timestamp: 1597444983 Existing access token is still valid
(1) Copyright 2023 Google LLC
As ferramentas acurl
e get_token
são disponibilizadas como "Software" na seção
contrato que rege seu uso do Google Cloud Platform, incluindo o Serviço
Os Termos específicos estão disponíveis em https://cloud.google.com/terms/service-terms.