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

Edge para nuvem privada v4.18.01

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
  • Como 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 para autenticação é o IdP SAML. Portanto, você deve adicionar o parâmetro de administrador do sistema ao seu IdP SAML.

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. Usar SAML com a API Edge Management contém instruções sobre como receber e atualizar tokens ao fazer chamadas da API de gerenciamento do Edge.

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

Use o comando apigee-adminapi.sh execute as mesmas tarefas de configuração do Edge ao fazer chamadas para ele API de gerenciamento. A vantagem do utilitário apigee-adminapi.sh é que ele:

  • Usar uma interface de linha de comando simples
  • Implementa o preenchimento de comando baseado em guias
  • Fornece informações de ajuda e 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 aprovar o administrador do sistema credenciais 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 o "-h" ao comando. 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:

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

Como alternativa, você pode 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 senha.
  • oauth-passcode especifica a senha extraída de http://edge_sso_IP_DNS:9099/passcode.

Por fim, você pode 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 originalmente. Neste exemplo, você especifica a senha porque recebeu originalmente a token usando get_token. Consulte Como usar o SAML com a API Edge Management.
  • oauh_token contém o com base no token correto anterior.

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

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

  • apigee-provision 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 é preciso especificar as credenciais de administrador do sistema em uma configuração arquivo

Esses utilitários recebem como entrada um arquivo de configuração que especifica o papel 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. Para exemplo, é possível 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ê os alterou de 9099 e HTTP.
  • OAUTH_FLOW especifica passcode ou password_grant. Neste exemplo, especificar password_grant porque você está passando a senha do administrador do sistema.
  • OAUTH_ADMIN_PASSWORD especifica a senha do administrador do sistema.

Como alternativa, você pode usar as seguintes propriedades para especificar as credenciais como parte de uma 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 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 passcode ou password_grant, dependendo de como você recebeu o token originalmente. Neste exemplo, você especifica a senha porque recebeu originalmente a token usando get_token. Consulte Como usar o SAML com a API Edge Management.
  • OAUTH_BEARER_TOKEN contém o token.