Documentation
Table of Contents
user.login
Опис
string/object user.login(object parameters)
Овај метод омогућава да се пријавите на API и генеришете аутентификацију токен.
Када користите овај метод, такође морате да урадите user.logout да бисте спречили генерисање великог броја записа отворених седница.
Овај метод је доступан само корисницима без аутентификације који не припадају ниједној корисничкој групи са омогућеном вишефакторском аутентификацијом.
Параметри
(object) Параметри који садрже корисничко име и лозинку.
Метод прихвата следеће параметре.
| Parameter | Type | Description |
|---|---|---|
| password | string | Корисничка лозинка. Понашање параметра: - обавезно |
| username | string | Корисничко име. Понашање параметра: - обавезно |
| userData | flag | Враћа информације о аутентификованом кориснику. |
Повратне вредности
(string/object) Ако се користи параметар userData, враћа објекат који садржи информације о аутентификованом кориснику.
Поред стандардних корисничких својстава, враћају се следеће информације:
| Property | Type | Description |
|---|---|---|
| auth_type | integer | Подразумевана аутентикација за корисника. Погледајте својство authentication_type Authentication object за листу могућих вредности. |
| debug_mode | integer | Да ли је режим за отклањање грешака омогућен или онемогућен за корисника. Погледајте својство debug_mode Објекат групе корисника за листу могућих вредности. |
| deprovisioned | boolean | Да ли корисник припада групи корисника deprovisioned. |
| gui_access | string | Корисников метод аутентификације на корисничком интерфејсу. Погледајте својство gui_access Објекат групе корисника за листу могућих вредности. |
| mfaid | integer | ID MFA метода који се користи за корисника током пријављивања. Враћа "0" ако је MFA онемогућен глобално или за све групе корисника којима корисник припада. |
| secret | string | Насумични низ од 32 карактера. Генерише се приликом пријављивања корисника. |
| sessionid | string | Токен за аутентификацију, који се мора користити у следећим API захтевима. |
| type | integer | Тип корисника. Погледајте својство type објекта Role object](/manual/api/reference/role/object#role) за листу могућих вредности. |
| userip | string | IP адреса корисника. |
Ако је корисник успешно аутентификован након једног или више неуспешних покушаја, метода ће вратити тренутне вредности за својства attempt_clock, attempt_failed и attempt_ip и затим их ресетујте.
Ако се параметар userData не користи, метода враћа токен за потврду идентитета који је неопходан за authentication.
Примери
Аутентификација кприсника
Аутентификујте корисника.
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix"
},
"id": 1
}Одговор:
Захтевање података о аутентификованом кориснику
Потврдите аутентичност и вратите додатне информације о кориснику.
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix",
"userData": true
},
"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",
"userdirectoryid": "0",
"type": 3,
"userip": "127.0.0.1",
"debug_mode": 0,
"gui_access": "0",
"mfaid": "1",
"deprovisioned": false,
"auth_type": 0,
"sessionid": "5b56eee8be445e98f0bd42b435736e42",
"secret": "cd0ba923319741c6586f3d866423a8f4"
},
"id": 1
}Погледајте такође
Извор
CUser::login() у ui/include/classes/api/services/CUser.php.