POST/api/auth/sso/exchange

Último passo de um início de sessão SSO (SAML/OIDC): troca o código de utilização única do redirecionamento por um token de acesso e um token de atualização.

Após o início de sessão no fornecedor de identidade, a Zentor App redireciona o navegador com um código de utilização única no parâmetro de consulta `sso_code`. Envie este código no campo `code`. A resposta contém `token` e `refreshToken`, como num início de sessão normal. Cada código é válido apenas uma vez e por pouco tempo. Um código já usado, expirado ou inválido resulta em 400 `SSO_EXCHANGE_INVALID`; o utilizador reinicia então o início de sessão SSO. Por isso, a chamada não é idempotente.

Visão geral

Chamada: POST /api/auth/sso/exchange. Este endpoint pertence ao grupo «Autenticação» da API da Zentor App. É de acesso público e não requer autenticação. A chamada não é idempotente: cada chamada bem-sucedida volta a desencadear a ação. Parâmetros obrigatórios: code (body). Casos de erro documentados: 400 SSO_EXCHANGE_INVALID. A resposta de exemplo abaixo mostra a estrutura de uma resposta bem-sucedida em formato JSON.

Autenticação e segurança

Não é necessária autenticação

Idempotente: Não

Parâmetros

code(body, string, obrigatório)— Código de utilização única do redirecionamento SSO

Pedido de exemplo

{"code":"<código de utilização única do redirect de callback SSO>"}

Resposta de exemplo

{"ok":true,"token":"<JWT>","refreshToken":"<Refresh-Token>"}

Códigos de erro

400 SSO_EXCHANGE_INVALID — O código é inválido, já foi usado ou expirou.

Comportamento verificado

Um código inválido devolve 400 `SSO_EXCHANGE_INVALID`. O caso de sucesso pressupõe um início de sessão completo no fornecedor de identidade configurado.

Autenticação

Artigos relacionados

← Autenticação