Это перевод страницы документации с английского языка. Помогите нам сделать его лучше.

Sidebar

Zabbix Summit 2022
View presentations

user.checkAuthentication

Описание

объект user.checkAuthentication

Этот метод проверяет и продлевает сессию пользователя.

Параметры

Этот метод принимает следующие параметры.

Параметр Тип Описание
extend логический Значение по умолчанию: "true". Если задать это значение равным "false", тогда будет выполнена проверка сессии без продления её времени жизни. Поддерживается начиная с Zabbix 4.0.
sessionid строка Id сессии пользователя.

По умолчанию вызов user.checkAuthentication метода проделевает сессию пользователя.

Возвращаемые значения

(объект) Возвращает объект, который содержит информацию о пользователе.

Примеры

Запрос:

{
           "jsonrpc": "2.0",
           "method": "user.checkAuthentication",
           "params": {
               "sessionid": "8C8447FF6F61D134CEAC740CCA1BC90D"
           },
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": {
               "userid": "1",
               "alias": "Admin",
               "name": "Zabbix",
               "surname": "Administrator",
               "url": "",
               "autologin": "1",
               "autologout": "0",
               "lang": "ru_RU",
               "refresh": "0",
               "type": "3",
               "theme": "default",
               "attempt_failed": "0",
               "attempt_ip": "127.0.0.1",
               "attempt_clock": "1355919038",
               "rows_per_page": "50",
               "debug_mode": true,
               "userip": "127.0.0.1",
               "sessionid": "8C8447FF6F61D134CEAC740CCA1BC90D",
               "gui_access": "0"
           },
           "id": 1
       }

Ответ идентичен вызову User.login с параметром "userData", который задан значением true (разница в том, что данные пользователя возвращаются по id сессии, а не по имени пользователю / паролю).

Исходный код

CUser::checkAuthentication() в frontends/php/include/classes/api/services/CUser.php.