user.logout

Descrição

string/object user.logout(array)

Este método permite sair da API e invalida o token de autenticação atual.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

Parâmetros

(array) O método aceita um array vazio.

Valores de retorno

(boolean) Retorna true se o usuário foi desconectado com sucesso.

Exemplos

Logout

Efetua logout da API.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "user.logout",
    "params": [],
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}

Veja também

Origem

CUser::login() em ui/include/classes/api/services/CUser.php.