Como usar o apigee-ssoadminapi.sh

Edge para nuvem privada v4.18.05

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

  • administrador
  • usuário de máquina

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

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

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

Sobre os usuários administradores

É necessário ter uma conta de administrador no módulo de SSO no Edge para gerenciar as propriedades do módulo.

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

  • username: definido pela propriedade SSO_ADMIN_NAME no arquivo de configuração usado para configurar o módulo SSO de borda. 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 usuários de máquina

O usuário da máquina pode receber tokens OAuth2 sem precisar especificar uma senha. Isso significa que é possível 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:

  • configurar o portal de serviços para desenvolvedores da Apigee (ou simplesmente o portal) para se comunicar com o Edge;
  • Quando o ambiente de desenvolvimento dá suporte à automação de tarefas de desenvolvimento comuns, como automação de testes ou integração/implantação contínua (CI/CD).

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

Como instalar o 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 de SSO do Edge. Normalmente, você instala o utilitário apigee-ssoadminapi.sh ao instalar o módulo 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 apigee-service instalado, conforme descrito em Instalar o utilitário de configuração da Apigee Edge.
  2. Instale o utilitário apigee-ssoadminapi.sh usado para gerenciar usuários administradores e de máquina no módulo 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 visualizar informações de ajuda sobre apigee-ssoadminapi.sh

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

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

Confira informações sobre esses comandos no arquivo /opt/apigee/apigee-ssoadminapi/README.md. Além disso, é possível especificar a opção "-h" para cada comando para consultar informações de uso.

Por exemplo, o comando a seguir:

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

Você pode invocar o utilitário apigee-ssoadminapi.sh passando todas as propriedades como argumentos de linha de comando ou no modo interativo respondendo a solicitações.

Por exemplo, para especificar todas as informações necessárias na linha de comando para ver 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 alguma informação necessária, como a senha do administrador, ela será exibida.

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

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

Você também pode usar o formulário interativo em que são solicitadas 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