Além do custom_sso dos passos 1 a 3, a Engage aceita entrada por provedores de identidade como SAML, Microsoft Entra ID e Google, e por uma página de login sua. Este artigo mostra quais são, como descobrir quais estão ligados na sua instância e o que cada um exige.
Neste artigo
- Antes de começar
- Ver o que está ligado na instância
- Custom Login URL: o contrato de ida e volta
- Cuidados
- Problemas comuns
Antes de começar
- Se o seu sistema já sabe quem é o usuário e você só quer levá-lo ao portal, fique no
custom_sso, começando em SSO — Passo 1: ligar o usuário do seu sistema ao usuário da Engage. Os modos abaixo servem quando a identidade vem de um provedor externo. - Todos eles são ligados na instância pelo Suporte: não há configuração por API. Para pedir, escreva para meajuda@engage.bz informando a instância, o ambiente e o provedor.
- Teste em homologação:
https://sandbox.engage.bz/api/v1. Homologação e produção têm configurações separadas.
Ver o que está ligado na instância
GET https://sandbox.engage.bz/api/v1/{customer_id}/infos/platforms?integrationTypeId=autenticacaoNo Postman: pasta 04 - SSO e identificadores, request Instância — plataformas de autenticação habilitadas. A resposta lista o platform_id de cada modo ligado.
platform_id | Como funciona | O que o Suporte precisa |
|---|---|---|
custom_login_url | A tela de login da Engage ganha um botão que leva o usuário para uma página sua. Sua página autentica e devolve o usuário ao portal | A URL da sua página |
protocolo_saml | Entrada por SAML 2.0, iniciada pela Engage: o usuário vai ao seu provedor de identidade e volta autenticado | O metadata do seu provedor de identidade |
azure_ad | Entrada com conta Microsoft Entra ID (antigo Azure AD) | O Application (client) ID e o tenant |
google | Entrada com conta Google | O client ID do Google |
active_directory | Entrada com usuário e senha de rede. Apesar do nome, não é entrada automática: o usuário digita as credenciais | Os dados do diretório |
Custom Login URL: o contrato de ida e volta
Quando esse modo está ligado, a Engage envia o usuário para a sua página assim:
{sua_url}?redirect_uri={url_de_volta}&back_uri={url_da_tela_de_login}Sua página deve:
- Autenticar o usuário do seu jeito.
- No servidor, chamar o
POST /authcomgrant_type=custom_sso— veja SSO — Passo 2: obter a chave de entrada (custom_sso). - Redirecionar o usuário para
{redirect_uri}?key={key}.
O back_uri é o caminho de desistência: use no botão "voltar" da sua tela.
Cuidado
O client_secret nunca vai para o navegador. No Custom Login URL, a chamada ao POST /auth precisa sair do servidor da sua página, não de JavaScript no cliente.
Cuidados
- O De/Para continua valendo no Custom Login URL. A chave sai do mesmo
custom_sso, então o identificador do usuário precisa estar gravado (Passo 1). - Cadastro automático vem desligado. No Entra ID e no Google, se o usuário não existir na Engage e o cadastro automático estiver desligado, o acesso é recusado. Peça ao Suporte para ligar, ou cadastre os usuários antes.
- Ligar em homologação não liga em produção. Cada ambiente tem a sua configuração.
- Valide um modo de cada vez. A tela de login mostra um botão por modo ligado.
Problemas comuns
| O que aparece | Causa provável | O que fazer |
|---|---|---|
| A tela de login não mostra o botão do provedor | O modo não está ligado nesta instância ou neste ambiente | Confira com o request de plataformas habilitadas e peça ao Suporte |
invalid_credentials no Entra ID ou no Google, com conta válida no provedor | O usuário não existe na Engage e o cadastro automático está desligado | Cadastre o usuário ou peça a ativação do cadastro automático |
| O SAML volta e o portal continua deslogado | A resposta do provedor não passou na validação: assinatura, certificado ou metadata desatualizado | Abra chamado informando data, hora e usuário — o resultado fica no log de auditoria da instância |
O usuário volta da sua página sem key na URL | Sua página não chamou o POST /auth ou não repassou a chave | Revise a montagem de {redirect_uri}?key={key} |
Próximo passo
Para abrir, de dentro da Engage, um conteúdo que fica em outro sistema, veja Acessar conteúdo hospedado em outro sistema (sem novo login).
Precisa de ajuda?
Escreva para meajuda@engage.bz informando o customer_id, o ambiente e o provedor. Nunca envie senhas, tokens, certificados privados ou o client_secret por e-mail.
Este artigo foi útil?
Que bom!
Obrigado pelo seu feedback
Desculpe! Não conseguimos ajudar você
Obrigado pelo seu feedback
Feedback enviado
Agradecemos seu esforço e tentaremos corrigir o artigo