Documentation
user.checkAuthentication
説明
object user.checkAuthentication
このメソッドは、ユーザー セッションをチェックして延長します。
パラメータ sessionid を設定して user.checkAuthentication メソッドを呼び出すと、デフォルトでユーザー セッションが延長されます。
パラメータ
このメソッドは、次のパラメーターを受け入れます。
| パラメータ | タイプ | 説明 |
|---|---|---|
| extend | boolean | ユーザーセッションを延長するかどうか。 デフォルト値: "true"。 値を"false"に設定すると、ユーザーセッションを延長せずにセッションを確認できます。 "sessionid"が設定されている場合に使用されます。 |
| sessionid | string | ユーザー セッションID "token"が設定されていない場合は必須 |
| token | string | ユーザー APIトークン "sessionid"が設定されていない場合は必須 |
戻り値
(object) ユーザーに関する情報を含むオブジェクトを返します。
例
Request:
{ "jsonrpc": "2.0", "method": "user.checkAuthentication", "params": { "sessionid": "673b8ba11562a35da902c66cf5c23fa2" }, "id": 1 }Response:
{ "jsonrpc": "2.0", "result": { "userid": "1", "username": "Admin", "name": "Zabbix", "surname": "Administrator", "url": "", "autologin": "1", "autologout": "0", "lang": "ru_RU", "refresh": "0", "theme": "default", "attempt_failed": "0", "attempt_ip": "127.0.0.1", "attempt_clock": "1355919038", "rows_per_page": "50", "timezone": "Europe/Riga", "roleid": "3", "type": 3, "sessionid": "673b8ba11562a35da902c66cf5c23fa2" "debug_mode": 0, "userip": "127.0.0.1", "gui_access": 0 }, "id": 1 }レスポンスは"userData"パラメーターがtrueに設定されたUser.loginメソッドの結果に似ています。（違いはユーザーデータがユーザー名/パスワードではなくセッションIDによって取得されることです）
ソース
CUser::checkAuthentication() in ui/include/classes/api/services/CUser.php.