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 | Beschrijving |
|---|---|---|
| wachtwoord (vereist) |
string | Gebruikerswachtwoord. |
| gebruikersnaam (verplicht) |
string | Gebruikersnaam. |
| userData | flag | Retourneer informatie over de geverifieerde gebruiker. |
Retourwaarden
(string/object) Als de parameter userData wordt gebruikt, wordt een object geretourneerd met informatie over de geverifieerde gebruiker.
Naast de standaard gebruikerseigenschappen, is de volgende informatie wordt geretourneerd:
| Eigenschap | Type | Beschrijving |
|---|---|---|
| debug_mode | boolean | Of de foutopsporingsmodus is ingeschakeld voor de gebruiker. |
| gui_access | integer | Verificatiemethode van de gebruiker naar de frontend. Raadpleeg de eigenschap gui_access van het gebruikersgroepsobject voor een lijst met mogelijke waarden. |
| sessionid | string | Authenticatietoken, dat moet worden gebruikt in de volgende API-verzoeken. |
| userip | string | IP-adres van de gebruiker. |
Als een gebruiker na één succesvol is geverifieerd of meer mislukte pogingen, retourneert de methode de huidige waarden voor: de eigenschappen attempt_clock, attempt_failed en attempt_ip en stel ze vervolgens opnieuw in.
Als de parameter userData niet wordt gebruikt, retourneert de methode een authenticatie token.
Het gegenereerde authenticatietoken moet worden onthouden en gebruikt in de parameter auth van de volgende JSON-RPC-verzoeken. Het is ook vereist bij 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:
Geauthenticeerde gebruikersgegevens opvragen
Verifieer en retourneer aanvullende informatie over de gebruiker.
Verzoek:
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix",
"userData": true
},
"id": 1
}Antwoord:
{
"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,
"debug_mode": 0,
"userip": "127.0.0.1",
"gui_access": "0",
"sessionid": "5b56eee8be445e98f0bd42b435736e42"
},
"id": 1
}Zie ook
Bron
CUser::login() in ui/include/classes/api/services/CUser.php.