Como usar o apigee-ssoadminapi.sh

Edge para nuvem privada v4.18.01

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

  • administrator
  • usuário de 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:

  • Ver a lista de usuários administradores/máquinas
  • Adicionar ou excluir usuários administradores/máquinas
  • Mudar a senha de usuários administradores/máquinas

Sobre os usuários administradores

É necessário ter uma conta de administrador no módulo SSO do Edge para gerenciar as propriedades do mais tarde neste módulo. Você também precisa de credenciais de conta de administrador para configurar a API BaaS ou o portal para conectar ao módulo.

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

  • username: definido pela propriedade SSO_ADMIN_NAME na arquivo de configuração usado para configurar o módulo SSO do Edge. O padrão é ssoadmin.
  • password: definida pela propriedade SSO_ADMIN_SECRET no arquivo de configuração usado para configurar o módulo 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 o API de gerenciamento.

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 de desenvolvimento comuns, como testar ou integração/implantação contínuas (CI/CD).

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

Como instalar o apigee-ssoadminapi.sh

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

Se você ainda não tiver instalado 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 a configuração da Apigee do Edge utilitário.
  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 seu 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
  • admin setpassword
  • SAML machineuser add
  • exclusão de saml machineuser
  • aaml machineuser list
  • saml machineuser setpassword

Acesse informações sobre esses comandos em /opt/apigee/apigee-ssoadminapi/README.md . Além disso, é possível especificar o "-h" a cada comando para ver as 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 para ver a lista de administradores usuários:

> 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 alguma informação necessária, como a senha do administrador, vai receber uma solicitação.

Neste exemplo, você omite os valores de --port e --ssl porque o módulo SSO do Edge usa o 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, todas as informações necessárias serão solicitadas:

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