检查认证

描述

object user.checkAuthentication

此方法检查或延长用户会话.

默认情况下调用 user.checkAuthentication 方法会延长用户会话.

参数

此方法接受如下参数.

参数类型描述
extendboolean默认值: “true”. 将其值设置为”false”将只会检查会话，不会延长会话有效期. 从 Zabbix 4.0 开始支持.
sessionidstring用户会话ID.

返回值

(object) 返回一个包含用户信息的对象.

示例

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "user.checkAuthentication",
  4.            "params": {
  5.                "sessionid": "673b8ba11562a35da902c66cf5c23fa2"
  6.            },
  7.            "id": 1
  8.        }

响应:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "userid": "1",
  5.                "username": "Admin",
  6.                "name": "Zabbix",
  7.                "surname": "Administrator",
  8.                "url": "",
  9.                "autologin": "1",
  10.                "autologout": "0",
  11.                "lang": "ru_RU",
  12.                "refresh": "0",
  13.                "theme": "default",
  14.                "attempt_failed": "0",
  15.                "attempt_ip": "127.0.0.1",
  16.                "attempt_clock": "1355919038",
  17.                "rows_per_page": "50",
  18.                "timezone": "Europe/Riga",
  19.                "roleid": "3",
  20.                "type": 3,
  21.                "sessionid": "673b8ba11562a35da902c66cf5c23fa2"
  22.                "debug_mode": 0,
  23.                "userip": "127.0.0.1",
  24.                "gui_access": 0
  25.            },
  26.            "id": 1
  27.        }

“userData” 参数设置为true，返回的响应和调用 User.login 方法返回相似(区别在于通过会话ID检索用户数据，而不是按照用户名/密码检索).

来源

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