Documentation
Table of Contents
user.checkAuthentication
Description
object user.checkAuthentication
This method checks and prolongs user session.
Calling user.checkAuthentication method prolongs user session by default.
Parameters
The method accepts the following parameters.
| Parameter | Type | Description |
|---|---|---|
| extend | boolean | Default value: "true". Setting it's value to "false" allows to check session without extending it's lifetime. Supported since Zabbix 4.0. |
| sessionid | string | User session id. |
Возвращаемые значения
(объект) Возвращает объект, который содержит информацию о пользователе.
Examples
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 }Response is similar to User.login call response with "userData" parameter set to true (the difference is that user data is retrieved by session id and not by username / password).
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() в ui/include/classes/api/services/CUser.php.