Integração SSO SAML 2.0
Visão Geral
Esta documentação descreve o processo de integração entre o Identity Provider (IdP) da organização cliente e o Service Provider (SP) da plataforma, utilizando o protocolo SAML 2.0 para autenticação via Single Sign-On (SSO).
Requisitos
Para implementar a integração SSO SAML 2.0, são necessários:
- Um Identity Provider compatível com SAML 2.0 (ex: Azure AD, Okta, ADFS, Auth0, Keycloak)
- Acesso administrativo ao Identity Provider da organização para configuração de novo aplicativo
- As informações de configuração do Service Provider da plataforma (detalhadas abaixo)
Configuração do Service Provider (SP)
Utilize as seguintes informações para configurar o Service Provider da plataforma no Identity Provider da organização:
| Parâmetro | Valor | Descrição |
|---|---|---|
| Entity ID / Issuer | [Url Ambiente] | Identificador único do Service Provider da plataforma |
| Assertion Consumer Service (ACS) URL | [Url Ambiente]/AuthSSO/AssertionConsumerService?Code={Code} | URL para onde o IdP enviará as respostas SAML |
| Single Logout Service (SLO) URL | [Url Ambiente]/AuthSSO/Logout | URL para logout único (opcional) |
Observação: O parâmetro
{Code}na URL ACS deve ser substituído por um identificador único para o ambiente/empresa do cliente, que será fornecido pela equipe de suporte técnico da plataforma.
Atributos Requeridos
O Service Provider da plataforma requer os seguintes atributos nas asserções SAML:
| Nome do Atributo | Descrição | Obrigatório | Exemplo |
|---|---|---|---|
| NameID | Identificador único do usuário | Sim | [email protected] |
| E-mail do usuário | Sim | [email protected] | |
| Nome | Nome completo do usuário | Sim | Nome do Colaborador |
| Perfil | Perfil de acesso do usuário | Não | Administrador |
Fornecendo Metadados do Identity Provider
Após configurar o Service Provider da plataforma no Identity Provider da organização, é necessário fornecer os metadados do Identity Provider para completar a integração. Existem duas opções:
1. URL do Metadata
Caso o Identity Provider disponibilize uma URL pública para o arquivo de metadados, esta deve ser fornecida à equipe de suporte técnico da plataforma.
2. Configuração Manual
Se não for possível fornecer a URL do metadata, serão necessárias as seguintes informações:
| Informação | Descrição |
|---|---|
| Entity ID / Issuer | Identificador único do Identity Provider |
| Single Sign-On URL | URL para onde serão enviadas as requisições SAML |
| Single Logout URL | URL para logout (opcional) |
| Certificado de Assinatura | Certificado X.509 público do Identity Provider para validação de assinaturas |
Testando a Integração
Após a conclusão da configuração em ambas as partes, a integração pode ser testada através dos seguintes passos:
- Acesse a aplicação da plataforma em [Url Ambiente]
- Clique no botão "Login SSO"
- O usuário será redirecionado para o Identity Provider da organização para autenticação ex:
- Após autenticação bem-sucedida, o usuário será redirecionado de volta à aplicação da plataforma
