user.logout

説明

string/object user.logout(array)

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

このメソッドは、あらゆる種類のユーザーが利用できます。メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳細については、ユーザーロールを参照してください。

パラメータ

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

戻り値

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

例

ログアウト

APIからログアウトします。

リクエスト:

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

レスポンス:

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

参照

ソース

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