Table of Contents
user.login
说明
string/object user.login(object parameters)
这个方法用户登录API和获取一个认证票据。
当使用这个方法的时候, 你必须使用 user.logout方法，防止产生大量的开放会话记录。.
Description
string/object user.login(object parameters)
This method allows to log in to the API and generate an authentication token.
When using this method, you also need to do user.logout to prevent the generation of a large number of open session records.
参数
<note important>这种方法对于未经身份验证的用户是可用的，并且必须在JSON-RPC请求中没有auth数调用。 :::
(object) 包含用户名和密码的参数。
该方法接受以下参数。
| 属性 类 | 说明 | |
|---|---|---|
| password (required) |
string | 用户密码。 未使用的HTTP身份验证。 |
| user (required) |
string | 用户名。 |
| userData | flag | R返回关于已认证用户的信息。 |
<note important>当使用HTTP认证时，API请求中的用户名必须与授权头中使用的名称相匹配。密码将不会被验证，并且可以省略。 :::
Parameters
This method is available to unauthenticated users and must be called without the auth parameter in the JSON-RPC request.
(object) Parameters containing the user name and password.
The method accepts the following parameters.
| Parameter | Type | Description |
|---|---|---|
| password (required) |
string | User password. Unused for HTTP authentication. |
| user (required) |
string | User name. |
| userData | flag | Return information about the authenticated user. |
When using HTTP authentication, the user name in the API request must match the one used in the Authorization header. The password will not be validated and can be omitted.
返回值
(string/object) 如果使用userDat参数，则返回包含关于经过身份验证用户信息的对象。
关于standard user properties, 返回以下信息:
| 属性 类 | 说明 | |
|---|---|---|
| debug_mode | boolean | 是否为用户启用了调试模式。 |
| gui_access | integer | 用户的身份验证方法到前端。 Refer to the gui_access property of the user group object for a list of possible values. |
| sessionid | string | 身份验证令牌，必须在下列API请求中使用。 |
| userip | string | 用户的IP地址。 |
<note tip>如果一个用户在一次或多次失败的尝试之后成功地进行了身份验证，该方法将返回attempt_clock、尝试失败和尝试ip属性的当前值，然后重新设置它们。 :::
如果不使用userData参数，该方法将返回身份验证令牌。
<note tip>所生成的认证令牌必须存储，并在以下JSON-RPC请求的auth参数中使用。在使用HTTP认证时也需要它。 :::
Return values
(string/object) If the userData parameter is used, returns an object containing information about the authenticated user.
Additionally to the standard user properties, the following information is returned:
| Property | Type | Description |
|---|---|---|
| debug_mode | boolean | Whether debug mode is enabled for the user. |
| gui_access | integer | User's authentication method to the frontend. Refer to the gui_access property of the user group object for a list of possible values. |
| sessionid | string | Authentication token, which must be used in the following API requests. |
| userip | string | IP address of the user. |
If a user has been successfully authenticated after one or more failed attempts, the method will return the current values for the attempt_clock, attempt_failed and attempt_ip properties and then reset them.
If the userData parameter is not used, the method returns an authentication token.
The generated authentication token should be remembered and used in the auth parameter of the following JSON-RPC requests. It is also required when using HTTP authentication.
示例
Examples
认证一个用户
Authenticating a user
认证一个用户
Request:
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"user": "Admin",
"password": "zabbix"
},
"id": 1
}Response:
Requesting authenticated user's information
Authenticate and return additional information about the user.
Request:
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"user": "Admin",
"password": "zabbix",
"userData": true
},
"id": 1
}Response:
{
"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": "5b56eee8be445e98f0bd42b435736e42",
"gui_access": "0"
},
"id": 1
}参考
来源
CUser::login() in frontends/php/include/classes/api/services/CUser.php.