Documentation
Table of Contents
user.login
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
string/object user.login(object parameters)
Este m¨¦todo permite iniciar sesi¨®n en la API y generar un token de autenticaci¨®n.
Al utilizar este m¨¦todo, tambi¨¦n debe hacer user.logout para evitar la generaci¨®n de un gran n¨²mero de registros de sesiones abiertas.
Este m¨¦todo solo est¨¢ disponible para usuarios no autenticados que no pertenecen a ning¨²n grupo de usuarios con la autenticaci¨®n multifactor habilitada. Este m¨¦todo debe llamarse sin el par¨¢metro "auth" en la solicitud JSON-RPC.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que contienen el nombre de usuario y la contrase?a.
El m¨¦todo acepta los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| password | cadena | Contrase?a de usuario. Comportamiento del par¨¢metro: - obligatorio |
| username | cadena | Nombre de usuario. Comportamiento del par¨¢metro: - obligatorio |
| userData | flag | Devuelve informaci¨®n sobre el usuario autenticado. |
Valores de retorno
(cadena/objeto) Si se utiliza el par¨¢metro userData, devuelve un objeto que contiene informaci¨®n sobre el usuario autenticado.
Adem¨¢s de las propiedades de usuario est¨¢ndar, el se devuelve la siguiente informaci¨®n:
| Propiedad | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| auth_type | integer | ´¡³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô predeterminada para el usuario. Consulte la propiedad authentication_type del objeto de autenticaci¨®n para obtener lista de valores posibles. |
| debug_mode | integer | Si el modo de depuraci¨®n est¨¢ habilitado o deshabilitado para el usuario. Consulte la propiedad debug_mode del objeto de grupo de usuarios para obtener una lista de valores posibles. |
| desaprovisionado | booleano | Si el usuario pertenece a un grupo de usuarios desaprovisionados. |
| gui_access | string | M¨¦todo de autenticaci¨®n del usuario en el frontend. Consulte la propiedad gui_access del objeto de grupo de usuarios para obtener un lista de valores posibles. |
| mfaid | entero | ID del m¨¦todo MFA que usar¨¢ el usuario durante el inicio de sesi¨®n. Devuelve "0" si MFA est¨¢ deshabilitado globalmente o para todos grupos de usuarios a los que pertenece el usuario. |
| secreto | cadena | Cadena aleatoria de 32 caracteres. Se genera al iniciar sesi¨®n el usuario. |
| sessionid | cadena | Token de autenticaci¨®n, que debe usarse en las siguientes solicitudes de API. |
| type | integer | Tipo de usuario. Consulte la propiedad type del objeto de rol para obtener una lista de valores posibles. |
| userip | string | Direcci¨®n IP del usuario. |
Si un usuario ha sido autenticado exitosamente despu¨¦s de una o m¨¢s intentos fallidos, el m¨¦todo devolver¨¢ los valores actuales para las propiedades attempt_clock, attempt_failed y attempt_ip y luego restablecerlos.
Si no se utiliza el par¨¢metro userData, el m¨¦todo devuelve un token de autenticaci¨®n.
Se debe recordar el token de autenticaci¨®n generado. y se utiliza en el par¨¢metro auth de las siguientes solicitudes JSON-RPC. ?l Tambi¨¦n es necesario cuando se utiliza la autenticaci¨®n HTTP.
Ejemplos
Autenticar a un usuario
Autenticar a un usuario.
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix"
},
"id": 1
}Respuesta:
Solicitando informaci¨®n de usuario autenticado
Autenticar y devolver informaci¨®n adicional sobre el usuario.
{
"jsonrpc": "2.0",
&±ç³Ü´Ç³Ù;³¾¨¦³Ù´Ç»å´Ç&±ç³Ü´Ç³Ù;: "usuario.iniciar sesi¨®n",
&±ç³Ü´Ç³Ù;±è²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ&±ç³Ü´Ç³Ù;: {
"nombre de usuario": "Administrador",
"contrase?a": "zabbix",
"datos de usuario": verdadero
},
&±ç³Ü´Ç³Ù;¾±»å±ð²Ô³Ù¾±´Ú¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 1
}Respuesta:
{
"jsonrpc": "2.0",
"resultado": {
"ID de usuario": "1",
"nombre de usuario": "Administrador",
"nombre": "Áú»¢¶Ä²©",
"apellido": "Administrador",
"URL": "",
"autologin": "1",
"cierre de sesi¨®n autom¨¢tico": "0",
"lang": "ru_RU",
"actualizar": "0",
"tema": "predeterminado",
"intento_fallido": "0",
"intento_ip": "127.0.0.1",
"intento_reloj": "1355919038",
"rows_per_page": "50",
"timezone": "Europa/Riga",
"roleid": "3",
"userdirectoryid": "0",
"tipo": 3,
"userip": "127.0.0.1",
&±ç³Ü´Ç³Ù;³¾´Ç»å´Ç³å»å±ð±è³Ü°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 0,
"gui_access": "0",
"mfaid": "1",
"desaprovisionado": falso,
&±ç³Ü´Ç³Ù;³Ù¾±±è´Ç³å²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 0,
"sessionid": "5b56eee8be445e98f0bd42b435736e42",
"secreto": "cd0ba923319741c6586f3d866423a8f4"
},
&±ç³Ü´Ç³Ù;¾±»å±ð²Ô³Ù¾±´Ú¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 1
}Ver tambi¨¦n
Fuente
CUser::login() en ui/include/classes/api/services/CUser.php.