注销用户

描述

string/object user.logout(array)

此方法用于用户注销API并使当前认证令牌失效.

任何类型的用户都可以使用此方法. 可在用户角色配置中撤销对此方法的使用. 参阅 角色.

参数

(array) 此方法接受一个空数组.

返回值

(boolean) 如果用户成功注销,返回 true.

示例

注销

通过API注销.

请求:

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

返回:

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

参考

来源

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