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

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

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

Usar o utilitário apigee-adminapi.sh para executar as mesmas tarefas de configuração do Edge que você executa fazendo chamadas para a API Edge Management. A vantagem da O utilitário apigee-adminapi.sh é que:

  • 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 ao 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:

  • A opção sso-url especifica o URL do módulo SSO da Apigee. Modificar a porta ou protocolo se 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 de sistema.
  • 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 passcode.
  • oauth-passcode especifica a senha recebida 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, especificar passcode porque originalmente você recebeu o token usando get_token. Consulte Como usar SAML com o Edge Management API.
  • 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:

  • A apigee-provision usada para criar organizações, ambientes e hospeda
  • 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 da Apigee. Modifique a porta ou se tiver alterado de 9099 e HTTP.
  • OAUTH_FLOW especifica passcode ou password_grant Neste exemplo, você especifica 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 passcode.
  • 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ê especificar passcode porque recebeu originalmente o token usando get_token. Consulte Como usar SAML com o Edge Management API.
  • OAUTH_BEARER_TOKEN contém o token.