Documentation
Table of Contents
user.login
Description
string/object user.login(object parameters)
Cette m¨¦thode permet de se connecter ¨¤ l'API et de g¨¦n¨¦rer un jeton d'authentification.
Lorsque vous utilisez cette m¨¦thode, vous devez ¨¦galement ex¨¦cuter user.logout pour emp¨ºcher la g¨¦n¨¦ration d¡¯un grand nombre d¡¯enregistrements de session ouverts.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
Cette m¨¦thode est disponible pour les utilisateurs non authentifi¨¦s et doit ¨ºtre appel¨¦e sans le param¨¨tre auth dans la requ¨ºte JSON-RPC.
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ contenant le nom d'utilisateur et le mot de passe.
La m¨¦thode accepte les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| password (obligatoire) |
string | Mot de passe de l'utilisateur. |
| user (obligatoire) |
string | Nom d'utilisateur. |
| userData | flag | Renvoie des informations sur l'utilisateur authentifi¨¦. |
Lorsque vous utilisez l'authentification HTTP, le nom d'utilisateur dans la requ¨ºte API doit correspondre ¨¤ celui utilis¨¦ dans l'en-t¨ºte Authorization. Le mot de passe ne sera pas valid¨¦ et peut ¨ºtre omis.
Valeurs retourn¨¦es
(string/object) Si le param¨¨tre userData est utilis¨¦, retourne un objet contenant des informations sur l'utilisateur authentifi¨¦.
En plus des propri¨¦t¨¦s de l'objet utilisateur standard, les informations suivantes sont retourn¨¦es :
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | Type | Description |
|---|---|---|
| debug_mode | boolean | Indique si le mode debug est activ¨¦ pour l'utilisateur. |
| gui_access | integer | M¨¦thode d'authentification de l'utilisateur ¨¤ l'interface. Reportez-vous ¨¤ la propri¨¦t¨¦ gui_access de l'objet groupe d'utilisateurs pour obtenir une liste des valeurs possibles. |
| sessionid | string | Jeton d'authentification, ¨¤ utiliser dans les demandes API qui suivront. |
| userip | string | Adresse IP de l'utilisateur. |
Si un utilisateur a ¨¦t¨¦ authentifi¨¦ avec succ¨¨s apr¨¨s une ou plusieurs tentatives infructueuses, la m¨¦thode renvoie les valeurs actuelles des propri¨¦t¨¦s attempt_clock, attempt_failed et attempt_ip, puis les r¨¦initialise..
Si le param¨¨tre userData n'est pas utilis¨¦, la m¨¦thode renvoie un jeton d'authentification.
Le jeton d'authentification g¨¦n¨¦r¨¦ doit ¨ºtre m¨¦moris¨¦ et utilis¨¦ dans le param¨¨tre auth des requ¨ºtes JSON-RPC suivantes. Il est ¨¦galement requis lors de l'utilisation de l'authentification HTTP.
Exemples
Authentifier un utilisateur
Authentifier un utilisateur.
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"user": "Admin",
"password": "zabbix"
},
"id": 1
}R¨¦ponse :
Demander les informations d'un utilisateur authentifi¨¦
Authentifiez-vous et renvoyez des informations suppl¨¦mentaires sur l'utilisateur.
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"user": "Admin",
"password": "zabbix",
"userData": true
},
"id": 1
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": {
"userid": "1",
"alias": "Admin",
"name": "Áú»¢¶Ä²©",
"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
}Voir ¨¦galement
Source
CUser::login() dans frontends/php/include/classes/api/services/CUser.php.