Sidebar

manual:api:reference:user:logout

user.logout

Description

string/object user.logout(array)

This method allows to log out of the API and invalidates the current authentication token.

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) The method accepts an empty array.

Return values

(boolean) Returns true if the user has been logged out successfully.

Examples

Logging out

Log out from the API.

Request:

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

Response:

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

See also

Source

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