Table of Contents
user.login
Beschrijving
string/object gebruiker.login(objectparameters)
Deze methode maakt het mogelijk om in te loggen op de API en een authenticatie te genereren teken.
Wanneer u deze methode gebruikt, moet u ook doen: user.logout om te voorkomen dat de genereren van een groot aantal open sessierecords.
Deze methode is alleen beschikbaar voor niet-geverifieerde gebruikers en moet worden aangeroepen zonder de parameter auth in de JSON-RPC verzoek.
Parameters
(object) Parameters die de gebruikersnaam en het wachtwoord bevatten.
De methode accepteert de volgende parameters.
| Parameter | Type | Omschrijving |
|---|---|---|
| password (vereist) |
string | Gebruikerswachtwoord. |
| username (vereist) |
string | Gebruikersnaam. |
| userData | flag | Informatie over de geauthenticeerde gebruiker retourneren. |
| user (verouderd) |
string | Deze parameter is verouderd, gebruik alstublieft username in plaats daarvan.Gebruikersnaam. |
Teruggegeven waarden
(string/object) Als de parameter userData wordt gebruikt, wordt een object teruggegeven met informatie over de geauthenticeerde gebruiker.
Naast de standaard gebruikersattributen, wordt de volgende informatie geretourneerd:
| Attribuut | Type | Omschrijving |
|---|---|---|
| debug_mode | integer | Of de debugmodus is ingeschakeld voor de gebruiker. Zie de debug_mode eigenschap van het Gebruikersgroep object voor een lijst van mogelijke waarden. |
| gui_access | integer | De authenticatiemethode van de gebruiker voor de frontend. Zie de gui_access eigenschap van het Gebruikersgroep object voor een lijst van mogelijke waarden. |
| sessionid | string | Authenticatietoken dat moet worden gebruikt in de volgende API-verzoeken. |
| type | integer | Gebruikerstype. Zie de type eigenschap van het Rolvert voor een lijst van mogelijke waarden. |
| userip | string | IP-adres van de gebruiker. |
Als een gebruiker succesvol is geauthenticeerd na één of meerdere mislukte pogingen, zal de methode de huidige waarden van de eigenschappen attempt_clock, attempt_failed en attempt_ip retourneren en ze vervolgens resetten.
Als de parameter userData niet wordt gebruikt, retourneert de methode een authenticatietoken.
Het gegenereerde authenticatietoken moet worden onthouden en worden gebruikt in de auth parameter van de volgende JSON-RPC-verzoeken. Het is ook vereist bij het gebruik van HTTP-authenticatie.
Voorbeelden
Een gebruiker authenticeren
Authenticeer een gebruiker.
Verzoek:
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix"
},
"id": 1
}Antwoord:
Informatie opvragen van geauthenticeerde gebruiker
Authenticeer en retourneer aanvullende informatie over de gebruiker.
Verzoek:
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix",
"userData": true
},
"id": 1
}Reactie:
{
"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",
"type": 3,
"userip": "127.0.0.1",
"debug_mode": 0,
"gui_access": 0,
"sessionid": "5b56eee8be445e98f0bd42b435736e42"
},
"id": 1
}Zie ook
Bron
CUser::login() in ui/include/classes/api/services/CUser.php.