Como usar os utilitários e APIs de administrador do Edge depois de ativar o SAML

Edge para nuvem privada v4.18.05

Esta seção descreve como executar ferramentas e comandos de administrador do sistema Edge após ativar o SAML. Muitas tarefas no Edge exigem credenciais de administração do sistema, como:

  • Como criar organizações e ambientes
  • Como adicionar e remover componentes do Edge
  • Comandos apigee-adminapi.sh executados.

No entanto, depois de ativar o SAML no Edge, você normalmente desativa a autenticação básica para que a única maneira de autenticação seja por meio do IdP SAML. Portanto, verifique se você adicionou a conta de administrador do sistema ao seu IdP SAML.

Como chamar as APIs de gerenciamento do Edge como administrador do sistema

Muitas chamadas da API Edge exigem que você transmita credenciais de administrador do sistema. O uso de SAML com a API Edge Management contém instruções sobre como receber e atualizar tokens ao fazer chamadas da API Edge Management.

Como usar o utilitário apigee-adminapi.sh com autenticação SAML

Use o utilitário apigee-adminapi.sh para realizar as mesmas tarefas de configuração do Edge que você executa fazendo chamadas para a API de gerenciamento do Edge. A vantagem do utilitário apigee-adminapi.sh é que ele:

  • Usar uma interface de linha de comando simples
  • Implementa o preenchimento automático do comando baseado em tabulação
  • Fornece ajuda e informações de uso
  • É possível mostrar a chamada de API correspondente se você decidir testar a API

Saiba mais em Como usar apigee-ssoadminapi.sh.

Depois de ativar a autenticação SAML, há várias maneiras de transmitir as credenciais de administrador do sistema para o utilitário apigee-adminapi.sh.

Use a opção "-h" para o comando para ver todas as opções de qualquer comando apigee-adminapi.sh, incluindo as opções para especificar credenciais SAML. Por exemplo:

apigee-adminapi.sh orgs list -h

Por exemplo, você pode transmitir as credenciais de administrador do sistema:

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow password_grant \
  --admin adminEmail --oauth-password adminPword

Em que:

  • A opção sso-url especifica o URL do módulo de SSO do Edge. Modifique a porta ou o protocolo se você tiver alterado de 9099 e HTTP.
  • oauth-flow especifica passcode ou password_grant. Neste exemplo, você especifica password_grant.
  • adminEmail é o endereço de e-mail do administrador do sistema.
  • oauth-password especifica a senha do administrador do sistema.

Como alternativa, é possível usar uma senha ao chamar o comando:

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode \
  --admin adminEmail --oauth-passcode passcode

Em que:

  • oauth-flow especifica passcode.
  • oauth-passcode especifica a senha recebida de http://edge_sso_IP_DNS:9099/passcode..

Por fim, é possível usar um token ao chamar o comando:

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode \
  --admin adminEmail --oauth-token token

Em que:

  • oauth-flow especifica passcode ou password_grant, dependendo de como você recebeu o token. Neste exemplo, você especifica passcode porque recebeu o token usando get_token. Consulte Como usar SAML com a API Edge.
  • oauh_token contém o token.

Como usar os utilitários do Edge com a autenticação SAML

Muitos utilitários do Edge exigem credenciais de administrador do sistema, como:

  • apigee-provision usado para criar organizações, ambientes e hosts virtuais
  • setup.sh usado para adicionar nós a um sistema atual
  • Qualquer outro utilitário em que você precise especificar as credenciais de administrador do sistema em um arquivo de configuração

Esses utilitários recebem como entrada um arquivo de configuração que especifica as credenciais do administrador do sistema usando as propriedades:

ADMIN_EMAIL="adminEmail"
APIGEE_ADMINPW=adminPWord

Se você omitir a senha, ela será solicitada.

Depois de ativar o SAML, você usa propriedades diferentes para especificar as credenciais do administrador do sistema. Por exemplo, você pode passar as credenciais de administrador do sistema:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=password_grant
OAUTH_ADMIN_PASSWORD=adminPWord

Em que:

  • SSO_LOGIN_URL especifica o URL do módulo SSO do Edge. Modifique a porta ou o protocolo se você tiver alterado de 9099 e HTTP.
  • OAUTH_FLOW especifica passcode ou password_grant. Neste exemplo, você especifica password_grant porque está transmitindo a senha do administrador do sistema.
  • OAUTH_ADMIN_PASSWORD especifica a senha do administrador do sistema.

Também é possível usar as seguintes propriedades para especificar as credenciais como parte de um fluxo de senha:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_ADMIN_PASSCODE=passcode

Em que:

  • OAUTH_FLOW especifica passcode.
  • OAUTH_ADMIN_PASSCODE especifica a senha recebida de http://edge_sso_IP_DNS:9099/passcode..

Por fim, use um token

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_BEARER_TOKEN=token

Em que:

  • OAUTH_FLOW especifica passcode ou password_grant, dependendo de como você recebeu o token. Neste exemplo, você especifica passcode porque recebeu o token usando get_token. Consulte Como usar SAML com a API Edge.
  • OAUTH_BEARER_TOKEN contém o token.