user.logout

説明

string/object user.logout(array)

このメソッドを使用すると、APIからログアウトして、現在の認証トークンを無効にすることができます。

このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。

パラメータ

(array) このメソッドは空の配列を受け入れます。

戻り値

(boolean) ユーザーが正常にログアウトされた場合はtrueを返します

例

ログアウト

APIからログアウト

Request:

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

Response:

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

参照

user.login

ソース

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

Documentation

user.logout

説明

パラメータ

戻り値

例

ログアウト

参照

ソース