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 met de gebruikersnaam en wachtwoord.

De methode accepteert de volgende parameters.

Parameter Type Beschrijving
password string Gebruikerswachtwoord.

Parametergedrag:
- vereist
username string Gebruikersnaam.

Parametergedrag:
- vereist
userData flag Informatie over de geauthenticeerde gebruiker retourneren.

Teruggegeven waarden

(string/object) Als de parameter userData wordt gebruikt, retourneert een object met informatie over de geauthenticeerde gebruiker.

Naast de standaard gebruikerskenmerken worden de volgende gegevens geretourneerd:

Kenmerk Type Beschrijving
auth_type integer Standaard authenticatie voor de gebruiker.

Verwijs naar het kenmerk authentication_type van het Authenticatie-object voor een lijst van mogelijke waarden.
debug_mode integer Of de debugmodus voor de gebruiker is ingeschakeld of uitgeschakeld.

Verwijs naar het kenmerk debug_mode van het Gebruikersgroep-object voor een lijst van mogelijke waarden.
deprovisioned boolean Of de gebruiker behoort tot een groep van gedeprovisioneerde gebruikers.
gui_access string Authenticatiemethode van de gebruiker voor de frontend.

Verwijs naar het kenmerk gui_access van het Gebruikersgroep-object voor een lijst van mogelijke waarden.
secret string Willekeurige tekenreeks van 32 tekens. Wordt gegenereerd bij het inloggen van de gebruiker.
sessionid string Authenticatietoken dat moet worden gebruikt in de volgende API-verzoeken.
type integer Gebruikerstype.

Verwijs naar het kenmerk type van het Rol-object voor een lijst van mogelijke waarden.
userip string IP-adres van de gebruiker.

Als een gebruiker succesvol is geauthenticeerd na één of meer mislukte pogingen, retourneert de methode de huidige waarden voor de kenmerken attempt_clock, attempt_failed en attempt_ip, waarna deze waarden worden gereset.

Als de parameter userData niet wordt gebruikt, retourneert de methode een authenticatietoken.

Het gegenereerde authenticatietoken moet worden onthouden en worden gebruikt in de parameter auth van de volgende JSON-RPC-verzoeken. Het is ook vereist bij het gebruik van HTTP-authenticatie.

Voorbeelden

Gebruiker authentiseren

Een gebruiker authentiseren.

Aanvraag:

{
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "username": "Admin",
        "password": "zabbix"
    },
    "id": 1
}

Reactie:

{
    "jsonrpc": "2.0",
    "result": "0424bd59b807674191e7d77572075f33",
    "id": 1
}

Informatie opvragen over geauthenticeerde gebruiker

Authenticeer en retourneer aanvullende informatie over de gebruiker.

Aanvraag:

{
    "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",
        "userdirectoryid": "0",
        "type": 3,
        "userip": "127.0.0.1",
        "debug_mode": 0,
        "gui_access": "0",
        "deprovisioned": false,
        "auth_type": 0,
        "sessionid": "5b56eee8be445e98f0bd42b435736e42",
        "secret": "cd0ba923319741c6586f3d866423a8f4"
    },
    "id": 1
}

Zie ook

Bron

CUser::login() in ui/include/classes/api/services/CUser.php.