user.logout

Descripción

string/object user.logout(array)

Este método permite cerrar sesión en la API e invalida el token de autenticación actual.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración de roles de usuario. Consulta Roles de usuario para obtener más información.

Parámetros

(array) El método acepta un array vacío.

Valores de retorno

(boolean) Devuelve true si el usuario ha cerrado sesión correctamente.

Ejemplos

Cerrar sesión

Cerrar sesión en la API.

Solicitud:

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

Respuesta:

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

Véase también

Fuente

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