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

Edge para nuvem privada v. 4.17.09

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

  • Como criar organizações e ambientes
  • Adicionar e remover componentes do Edge
  • Executar comandos apigee-adminapi.sh
  • muitas outras tarefas

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

Chamar APIs de gerenciamento do Edge como administrador do sistema

Muitas chamadas de API do Edge exigem que você transmita credenciais de administrador do sistema. O artigo Como usar o 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 a autenticação SAML

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

  • Usar uma interface simples de linha de comando
  • Implementa o preenchimento de comando com tabulação
  • Oferece ajuda e informações de uso
  • Pode exibir a chamada de API correspondente se você decidir testar a API

Para mais informações, consulte Como usar o apigee-ssoadminapi.sh.

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

É possível conferir todas as opções de qualquer comando apigee-adminapi.sh, incluindo as opções para especificar credenciais SAML, usando a opção "-h" no comando. Por exemplo:

> apigee-adminapi.sh orgs list -h

Por exemplo, é possível 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:

  • sso-url especifica o URL do módulo SSO do Edge. Modifique a porta ou o protocolo se você tiver mudado de 9099 e HTTP.
  • oauth-flow especifica senha 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, use 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 a senha.
  • 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 código de acesso ou password_grant, dependendo de como você recebeu o token. Neste exemplo, você especifica código de acesso porque originalmente recebeu o token usando get_token. Consulte Como usar o SAML com a API Edge Management.
  • 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 existente
  • Qualquer outro utilitário em que você precise especificar as credenciais de administrador do sistema em um arquivo de configuração

Esses utilitários usam 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, use propriedades diferentes para especificar as credenciais do administrador do sistema. Por exemplo, é possível transmitir 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 de SSO do Edge. Modifique a porta ou o protocolo se você os alterou de 9099 e HTTP.
  • OAUTH_FLOW especifica código de acesso ou password_grant. Neste exemplo, você especifica password_grant porque está passando a senha do administrador do sys.
  • OAUTH_ADMIN_PASSWORD especifica a senha do administrador do sistema.

Como alternativa, é possível usar as propriedades a seguir 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 a senha.
  • OAUTH_ADMIN_PASSCODE especifica a senha recebida de http://edge_sso_IP_DNS:9099/passcode.

Por fim, é possível usar 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 código de acesso ou password_grant, dependendo de como você recebeu o token. Neste exemplo, você especifica a senha porque recebeu o token originalmente usando get_token. Consulte Como usar o SAML com a API Edge Management.
  • OAUTH_BEARER_TOKEN contém o token.