Documentation
Table of Contents
user.checkAuthentication
説明
object user.checkAuthentication
このメソッドは、ユーザーセッションをチェックして延長します。
user.checkAuthenticationメソッドを呼び出すと、デフォルトでユーザーセッションが延長されます。
パラメータ
このメソッドは、次のパラメーターを受け入れます。
| パラメータ | タイプ | 説明 |
|---|---|---|
| extend | boolean | デフォルト値"true"。"false"に設定すると有効期間を延長せずにセッションをチェックできます。 Zabbix4.0以降でサポートされています。 |
| sessionid | string | ユーザーセッションID. |
戻り値
(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によって取得されることです）
Check authentication using authentication token
Check and prolong a user session using the user authentication token, and return additional information about the user.
{ "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", "userdirectoryid": "0", "ts_provisioned": "0", "type": 3, "userip": "127.0.0.1", "debug_mode": 0, "gui_access": "0", "deprovisioned": false, "auth_type": 0, "sessionid": "673b8ba11562a35da902c66cf5c23fa2", "secret": "0e329b933e46984e49a5c1051ecd0751" }, "id": 1 }Check authentication using API token
Check a user session using the user API token, and return additional information about the user.
{ "jsonrpc": "2.0", "method": "user.checkAuthentication", "params": { "token": "00aff470e07c12d707e50d98cfe39edef9e6ec349c14728dbdfbc8ddc5ea3eae" }, "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": "1355919338", "rows_per_page": "50", "timezone": "Europe/Riga", "roleid": "3", "userdirectoryid": "0", "ts_provisioned": "0", "type": 3, "userip": "127.0.0.1", "debug_mode": 0, "gui_access": "1", "deprovisioned": false, "auth_type": 0 }, "id": 1 }ソース
CUser::checkAuthentication() in ui/include/classes/api/services/CUser.php.