Pular para o conteúdo

Logout

Descrição

Este endpoint permite ao integrador encerrar a sessão autenticada, invalidando o token de acesso utilizado nas chamadas subsequentes à API.

Após a execução do logout, o Access Token deixa de ser válido e um novo processo de autenticação deverá ser realizado para acessar novamente os recursos protegidos da API.

HTTP request

DELETE /disconnect/api/v3/logout

Request Headers

ChaveValor
AuthorizationBearer <ACCESS_TOKEN>
Acceptapplication/json

Exemplo de Requisição

DELETE /disconnect/api/v3/logout
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/json

Estrutura da Resposta

NomeTipoDescrição
datastringMensagem indicando o resultado da operação de logout.

Exemplo de Resposta (Sucesso com Dados)

{
    "data": "Logout successful"
}

Códigos de Status da Resposta

CódigoDescrição
200Sucesso – A requisição foi processada com êxito.
400Requisição inválida – Parâmetros incorretos ou formato de requisição inválido.
401Não autorizado – Token de autenticação inválido ou ausente.
500Erro interno do servidor – Ocorreu um erro inesperado no servidor.