user.logout

描述

string/object user.logout(array)

此方法允许从API注销并使当前认证令牌失效。

此方法适用于所有类型的用户。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅User roles

参数

(array) 该方法接受一个空的array。

返回值

(boolean) 若用户已成功登出则返回 true

示例

登出

从API注销登录。

请求:

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

响应:

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

另请参阅

来源

CUser::login() 位于 ui/include/classes/api/services/CUser.php 文件中。