user.checkAuthentication
描述
object user.checkAuthentication
此方法用于检查并延长用户会话。
调用user.checkAuthentication方法时，若参数sessionid被设置， 默认情况下会延长用户会话。
参数
该方法接受以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| extend | boolean | 是否延长用户会话。 默认值: "true"。设置为"false"可以在不延长会话的情况下检查用户会话状态。 仅在 sessionid设置时使用。 |
| sessionid | string | 用户会话ID。 必填 当 token未设置时。 |
| token | string | 用户api-令牌。 必填 当 sessionid未设置时。 |
返回值
(object) 返回一个包含用户信息的object。
示例
请求:
{ "jsonrpc": "2.0", "method": "user.checkAuthentication", "params": { "sessionid": "673b8ba11562a35da902c66cf5c23fa2" }, "id": 1 }响应:
{ "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 }响应类似于 User.login 调用响应，其中 "userData" 参数设置为 true（区别在于用户数据是通过会话ID而非用户名/密码获取）。
来源
CUser::checkAuthentication() 位于 ui/include/classes/api/services/CUser.php 文件中.