Como usar o apigee-ssoadminapi.sh

Edge para nuvem privada v. 4.17.09

O módulo de SSO do Edge oferece suporte a dois tipos de contas:

  • administrator
  • usuário da máquina

O utilitário apigee-ssoadminapi.sh permite gerenciar os usuários de administrador e de máquina associados ao módulo de SSO do Edge.

Use o utilitário apigee-ssoadminapi.sh para:

  • Conferir a lista de usuários administradores/da máquina
  • Adicionar ou excluir usuários de administrador/máquina
  • Mudar a senha de usuários de administrador/máquina

Sobre os usuários administradores

Uma conta de administrador no módulo de SSO do Edge é necessária para gerenciar as propriedades do módulo. Você também precisa de credenciais de conta de administrador para configurar a API BaaS ou o portal para se conectar ao módulo.

Por padrão, quando você instala o módulo de SSO do Edge, ele cria uma conta de administrador com as seguintes credenciais:

  • username: definido pela propriedade SSO_ADMIN_NAME no arquivo de configuração usado para configurar o módulo de SSO do Edge. O padrão é ssoadmin.
  • senha: definida pela propriedade SSO_ADMIN_SECRET no arquivo de configuração usado para configurar o módulo de SSO do Edge.

Sobre os usuários de máquina

Um usuário de máquina pode receber tokens OAuth2 sem precisar especificar uma senha. Isso significa que você pode automatizar completamente o processo de recebimento e atualização de tokens OAuth2 usando a API de gerenciamento do Edge.

Normalmente, você usa usuários de máquina para:

  • Como configurar o portal de serviços para desenvolvedores para se comunicar com o Edge
  • Quando o ambiente de desenvolvimento oferece suporte à automação para tarefas comuns de desenvolvimento, como automação de testes ou integração/entrega contínuas (CI/CD).

Para mais informações, consulte Usar SAML com tarefas automatizadas.

Instalar apigee-ssoadminapi.sh

Instale o utilitário apigee-ssoadminapi.sh no nó do Servidor de gerenciamento de borda em que você instalou o módulo SSO de Borda. Normalmente, você instala o utilitário apigee-ssoadminapi.sh quando instala o módulo de SSO do Edge.

Se você ainda não instalou o utilitário apigee-ssoadminapi.sh:

  1. Faça login no nó do servidor de gerenciamento. Esse nó já deve ter o apigee-service instalado, conforme descrito em Instalar o utilitário de configuração Edge Apigee.
  2. Instale o utilitário apigee-ssoadminapi.sh usado para gerenciar usuários de administradores e máquinas para o módulo de SSO do Edge:
    >
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Saia do shell e faça login novamente para adicionar o utilitário apigee-ssoadminapi.sh ao caminho.

Como conferir as informações de ajuda para o apigee-ssoadminapi.sh

Os comandos disponíveis para o utilitário são:

  • admin add
  • exclusão de administrador
  • Lista de administradores
  • definirsenha do administrador
  • saml machineuser add
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

É possível conferir informações sobre esses comandos no arquivo /opt/apigee/apigee-ssoadminapi/README.md. Além disso, você pode especificar a opção "-h" para cada comando para conferir informações de uso. Por exemplo, o seguinte comando:

> apigee-ssoadminapi.sh admin list -h

retorna:

admin list 
  --admin SSOADMIN_CLIENT_NAME      Name of the client having administrative privilege on sso
  --secret SSOADMIN_CLIENT_SECRET   Secret/Password for the client
  --host SSO_HOST                   Hostname of SSO server to connect
  --port SSO_PORT                   Port to use during request
  --ssl SSO_URI_SCHEME              Set to https, defaults to http
  --debug                           Set in debug mode, turns on verbose in curl
  -h                                Displays Help

Como invocar o utilitário apigee-ssoadminapi.sh

É possível invocar o utilitário apigee-ssoadminapi.sh transmitindo todas as propriedades como argumentos de linha de comando ou no modo interativo respondendo às solicitações.

Por exemplo, para especificar todas as informações necessárias na linha de comando e conferir a lista de usuários administradores:

> apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123 --host 35.197.94.184

retorna:

[
  {
    "client_id": "ssoadmin",
    "access_token_validity": 300
  }
]

Se você omitir qualquer informação necessária, como a senha de administrador, vai receber uma solicitação.

Neste exemplo, você omite os valores de --port e --ssl porque o módulo de SSO do Edge usa os valores padrão de 9099 para --port e http para --ssl. Se a instalação não usar esses padrões, especifique-os:

> apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123 --host 35.197.94.184 --port 9443 --ssl https

Como alternativa, use o formulário interativo em que você vai receber todas as informações:

> apigee-ssoadminapi.sh admin list

Em seguida, você vai precisar fornecer todas as informações necessárias:

SSO admin name (current): ssoadmin
SSO Admin secret (current): 
SSO host: 35.197.94.184