Documentation
Table of Contents
user.login
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
string/object user.login(object parameters)
Aquest m¨¨tode permet connectar a l'API i generar un token d'autenticaci¨®.
Quan empreu aquest m¨¨tode, haureu de fer user.logout per previndre la generaci¨® d'un llarg nombre de registres de sessi¨® oberts.
Aquest m¨¨tode nom¨¦s ¨¦s disponible per usuaris no autenticats i se l'ha de cridar amb el par¨¤metre "auth" a una petici¨® JSON-RPC.
±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ
(object) ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ que contenen nom d'usuari i mot de pas.
El m¨¨tode admet els par¨¤metres seg¨¹ents.
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| password | string | mot de pas de l'usuari. Comportament de la propietat: - obligatori |
| username | string | Nom d'usuari. Comportament de la propietat: - obligatori |
| userData | flag | Retorna informaci¨® de l'usuari autenticat. |
Valors de retorn
(string/object) Si s'empra el par¨¤metre userData, retorna un objecte que cont¨¦ informaci¨® sobre l'usuari autenticat.
A m¨¦s de les propietats de l'objecte est¨¤ndard usuari, es retorna la informaci¨® seg¨¹ent:
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| auth_type | enter | ´¡³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨® per defecte per a l'usuari. Consulteu la propietat authentication_type de l'objecte d'autenticaci¨® per a un llistat de possibles valors. |
| debug_mode | enter | Si el mode de depuraci¨® ¨¦s activat o desactivat per a l'usuari. Consulteu la propietat debug_mode de l'Objecte del grup d'usuaris per obtindre una llista de possibles valors. |
| deprovisioned | ²ú´Ç´Ç±ô±ð¨¤ | Si l'usuari pertany a un grup d'usuaris desprovisionats. |
| gui_access | cadena | M¨¨tode d'autenticaci¨® de l'usuari a la interf¨ªcie. Consulteu la propietat gui_access de l'objecte del grup d'usuaris el llistat de possibles valors. |
| secret | cadena | Cadena aleat¨°ria de 32 car¨¤cters. Es genera a l'inici de sessi¨® de l'usuari. |
| sessionid | cadena | Token d'autenticaci¨®, que s'ha d'emprar a les peticions d'API seg¨¹ents. |
| type | enter | Tipus d'usuari. Consulteu la propietat type de l'objecte rol per obtindre una llista de valors possibles. |
| userip | cadena | adre?a IP de l'usuari. |
::: consell de notes Si un usuari s'ha autenticat correctament despr¨¦s d'un o m¨¦s intents fallits, el m¨¨tode retornar¨¤ els valors actuals de les propietats "attempt_clock", "attempt_failed" i "attempt_ip" i despr¨¦s el reiniciar¨¤. :::
Si no s'empra el par¨¤metre userData, el m¨¨tode retorna un token d'autenticaci¨®.
Cal recordar el token d'autenticaci¨® generat i s'empra al par¨¤metre auth de les seg¨¹ents peticions JSON-RPC. Aix¨° tamb¨¦ ¨¦s necessari quan s'empra l'autenticaci¨® HTTP.
Exemples
Autenticar un usuari
Autentica un usuari.
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix"
},
"id": 1
}Resposta:
Demanar informaci¨® de l'usuari autenticat
Autentica i reenvia la informaci¨® suplement¨¤ria de l'usuari.
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix",
"userData": true
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"userid": "1",
"username": "Admin",
"name": "Áú»¢¶Ä²©",
"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,
"debug_mode": 0,
"userip": "127.0.0.1",
"gui_access": "0",
"userdirectoryid": 0,
"sessionid": "5b56eee8be445e98f0bd42b435736e42"
},
"id": 1
}Veieu tamb¨¦
Font
CUser::login() in ui/include/classes/api/services/CUser.php.