O módulo SSO da Apigee oferece suporte a dois tipos de contas:
O utilitário apigee-ssoadminapi.sh
permite gerenciar as contas de usuário do administrador e da máquina
associadas ao módulo de SSO da Apigee.
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 da Apigee para gerenciar as propriedades do módulo.
Por padrão, quando você instala o módulo SSO da Apigee, 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 SSO da Apigee. O padrão éssoadmin.
- password: definida pela propriedade
SSO_ADMIN_SECRET
no arquivo de configuração usado para configurar o módulo SSO da Apigee.
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 comuns de desenvolvimento, como automação de testes ou CI/CD.
Para mais informações, consulte Automatizar tarefas para IdPs externos.
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 da Apigee. Normalmente, você instala o utilitário apigee-ssoadminapi.sh
ao instalar o módulo SSO da Apigee.
Se você ainda não instalou o utilitário apigee-ssoadminapi.sh
:
- 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 do Edge. - Instale o utilitário
apigee-ssoadminapi.sh
usado para gerenciar usuários administradores e de máquina no módulo SSO da Apigee executando o seguinte comando:/opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
- Saia do shell e faça login novamente para adicionar o utilitário
apigee-ssoadminapi.sh
ao seu caminho.
Ver 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
(use o comandosaml
para todos os IdPs, incluindo LDAP e SAML)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 as 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
Invoque 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 às 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 da Apigee 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