user.checkAuthentication

Beschrijving

object user.checkAuthentication

Deze methode controleert en verlengt de gebruikerssessie.

Het oproepen van de methode user.checkAuthentication met de parameter sessionid ingesteld verlengt standaard de gebruikerssessie.

Parameters

De methode accepteert de volgende parameters.

Parameter Type Beschrijving
extend boolean Of de gebruikerssessie moet worden verlengd.

Standaardwaarde: "true". Het instellen van de waarde op "false" maakt het mogelijk om de gebruikerssessie te controleren zonder deze te verlengen.

Wordt gebruikt als sessionid is ingesteld.
sessionid string Gebruikerssessie-ID.

Vereist als token niet is ingesteld.
token string Gebruikers API-token.

Vereist als sessionid niet is ingesteld.

Retourwaarden

(object) Retourneert een object dat informatie over de gebruiker bevat.

Voorbeelden

Verzoek:

{
    "jsonrpc": "2.0",
    "method": "user.checkAuthentication",
    "params": {
        "sessionid": "673b8ba11562a35da902c66cf5c23fa2"
    },
    "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,
        "sessionid": "673b8ba11562a35da902c66cf5c23fa2"
        "debug_mode": 0,
        "userip": "127.0.0.1",
        "gui_access": 0
    },
    "id": 1
}

Reactie is vergelijkbaar met Gebruiker.login oproepreactie met "userData" parameter is ingesteld op true (het verschil is dat gebruikersgegevens zijn opgehaald door sessie-ID en niet door gebruikersnaam / wachtwoord).

Bron

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