登录用户

描述

string/object user.login(object parameters)

此方法用于登录到API并生成身份验证令牌.

使用此方法, 你同时需要使用 注销 方法, 防止产生大量未关闭的会话记录.

此方法仅适用于未认证用户，同时在JSON-RPC请求中不能带有auth参数.

参数

(object) 参数包含用户名和用户密码.

此方法接受如下参数.

参数类型描述
password
(required)		string用户密码.
username
(required)		string用户名.
userDataflag返回认证成功的用户信息.

返回值

(string/object) 如果使用 userData 参数, 返回一个包含认证成功用户信息的对象.

除了 用户标准信息, 其他返回信息如下:

属性类描述
debug_modeboolean用户是否启用了调试模式.
gui_accessinteger前端认证使用的用户身份验证方法.

可能值的列表,请参阅 用户组 的 gui_access 属性.
sessionidstring身份验证令牌，必须在下列API请求中使用.
useripstring用户的IP地址.

如果一个用户在一次或多次失败的尝试之后成功地进行了身份验证, 该方法将返回attempt_clock、attempt_failed和attempt_ip属性的当前值，然后重新设置它们.

如果不使用userData参数，该方法将返回身份验证令牌.

所生成的认证令牌必须存储, 并在以下JSON-RPC请求的auth参数中使用. 在使用HTTP认证时也需要它.

示例

单用户认证

单用户认证.

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "user.login",
  4.            "params": {
  5.                "username": "Admin",
  6.                "password": "zabbix"
  7.            },
  8.            "id": 1
  9.        }

返回:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": "0424bd59b807674191e7d77572075f33",
  4.            "id": 1
  5.        }

请求已验证用户的信息

验证并返回有关用户的附加信息.

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "user.login",
  4.            "params": {
  5.                "username": "Admin",
  6.                "password": "zabbix",
  7.                "userData": true
  8.            },
  9.            "id": 1
  10.        }

返回:

  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.                "debug_mode": 0,
  22.                "userip": "127.0.0.1",
  23.                "gui_access": "0",
  24.                "sessionid": "5b56eee8be445e98f0bd42b435736e42"
  25.            },
  26.            "id": 1
  27.        }

参考

来源

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