Nunciatura Provista

API Documentation V1

Logout

Invalida o token atual e encerra a sessão

Este endpoint é do tipo: Protected

Descrição

Encerra a sessão do usuário com as seguintes funcionalidades:

  • Valida o token JWT no header Authorization
  • Invalida o token JWT atual
  • Limpa cache de autenticação do usuário
  • Registra logout no log de auditoria
  • Retorna sucesso mesmo se houver erro na invalidação (por segurança)
  • Retorna erro 401 se o token não for fornecido, for inválido ou expirado

Detalhes do Endpoint

VERBO

POST

URL BASE

http://api.provista.dev.nabrasil.org.br/v1

ENDPOINT

/auth/logout

Cabeçalhos

ParâmetroValor
Content-Typeapplication/json
AuthorizationBearer <token>

Respostas

Sucesso - 200

{
  "success": true,
  "message": "Logout realizado com sucesso"
}

Erro - 401 (Token não fornecido ou inválido)

{
  "success": false,
  "message": "Token não fornecido"
}

Condição: Token JWT não foi enviado no header Authorization

Erro - 401 (Token expirado)

{
  "success": false,
  "message": "Token expirado"
}

Condição: Token JWT expirado (TTL de 180 minutos excedido)

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Token inválido"
}

Condição: Token JWT malformado ou com assinatura inválida

Observação: Quando o token é válido, o endpoint sempre retorna sucesso (200), mesmo em caso de falha na invalidação do token, para não expor informações sensíveis do sistema.

Códigos de Resposta

Código Descrição
200 Logout realizado com sucesso
401 Token não fornecido, inválido ou expirado