Single Sign-On
Guia relacionado: Single Sign-On.
Os callbacks são chamados pelo provedor de identidade, por meio do navegador do usuário, como parte de uma transação autêntica. Não os chame com valores construídos manualmente.
GET /sso/login
Inicia o login federado e redireciona o navegador ao provedor.
Acesso: público.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
provider | query | Sim | Identificador do provedor configurado. |
Respostas: 302 — redirecionamento ao provedor de identidade.
GET /sso/logout
Inicia o logout federado.
Acesso: sessão SSO.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
provider | query | Sim | Identificador do provedor configurado. |
Respostas: 302 — redirecionamento ao provedor ou ao destino de logout; 401 — sessão não aceita.
GET POST /sso/oauth2/cb
Callback de autorização OAuth 2.0 e 2.1/OpenID Connect.
Acesso: provedor.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
state | query (GET) ou formulário (POST) | Sim | Estado criado no início do fluxo. |
code | query (GET) ou formulário (POST) | Sim | Código de autorização emitido pelo provedor. |
Respostas: 302 — sessão estabelecida e redirecionamento.
GET POST /sso/oauth2/logout/cb
Callback de logout OAuth 2.0.
Acesso: provedor.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
state | query (GET) ou formulário (POST) | Sim | Estado do fluxo de logout. |
provider | query (GET) ou formulário (POST) | Sim | Identificador do provedor. |
Respostas: 302 — redirecionamento após o logout.
POST /sso/saml2/acs
Assertion Consumer Service: recebe a resposta de autenticação SAML 2.0.
Acesso: provedor.
| Campo (formulário) | Obrigatório | Descrição |
|---|---|---|
SAMLResponse | Sim | Resposta SAML em Base64. |
RelayState | Não | Estado repassado pelo provedor, quando aplicável. |
Respostas: 302 — sessão estabelecida e redirecionamento.
GET POST /sso/saml2/slo
Single Logout: recebe a mensagem de logout SAML 2.0.
Acesso: provedor.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
SAMLResponse | query (GET) ou formulário (POST) | Não | Resposta de logout SAML em Base64. |
RelayState | query (GET) ou formulário (POST) | Não | Estado repassado pelo provedor. |
Respostas: 302 — redirecionamento após o logout.
GET /sso/saml2/metadata
Devolve os metadados XML do provedor SAML 2.0, usados para cadastrar a API no provedor de identidade. O provedor pode ser informado na query string ou no caminho (/sso/saml2/metadata/{provider}).
Acesso: público.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
provider | query, ou {provider} no caminho | Sim | Identificador do provedor SAML. |
Respostas: 200 — metadados XML.