user.checkAuthentication

Beschrijving

object user.checkAuthentication

Deze methode controleert en verlengt de gebruikerssessie.

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

Parameters

De methode accepteert de volgende parameters.

Parameter	Type	Omschrijving
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. Gedrag van parameters: - ondersteund als `sessionid` is ingesteld
sessionid	string	Gebruikers authenticatietoken. Gedrag van parameters: - vereist als `token` niet is ingesteld
secret	string	Willekeurige tekenreeks van 32 tekens. Wordt gegenereerd bij het inloggen van de gebruiker.
token	string	Gebruikers API-token. Gedrag van parameters: - vereist als `sessionid` niet is ingesteld

Retourwaarden

(object) Geeft een object terug met informatie over de gebruiker.

Naast de standaard gebruikers eigenschappen, worden de volgende gegevens ook geretourneerd.

Eigenschap	Type	Beschrijving
auth_type	integer	Standaard authenticatie voor de gebruiker. Zie de eigenschap `authentication_type` van het Authenticatie object voor een lijst van mogelijke waarden.
debug_mode	integer	Of debugmodus ingeschakeld of uitgeschakeld is voor de gebruiker. Zie de eigenschap `debug_mode` van het Gebruikersgroep object voor een lijst van mogelijke waarden.
deprovisioned	boolean	Of de gebruiker behoort tot een gebruikersgroep met gedeprovisioneerde gebruikers.
gui_access	string	De authenticatiemethode van de gebruiker voor de frontend. Zie de eigenschap `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. Eigenschap `secret` wordt niet geretourneerd als de gebruikerssessie wordt gecontroleerd met behulp van een API-token.
sessionid	string	Authenticatietoken dat moet worden gebruikt in de volgende API-verzoeken. Eigenschap `sessionid` wordt niet geretourneerd als de gebruikerssessie wordt gecontroleerd met behulp van een API-token.
type	integer	Gebruikerstype. Zie de eigenschap `type` van het Rol object voor een lijst van mogelijke waarden.
userip	string	IP-adres van de gebruiker.

Voorbeelden

Controleer authenticatie met behulp van een authenticatietoken

Controleer en verleng een gebruikerssessie met behulp van het authenticatietoken van de gebruiker en geef aanvullende informatie over de gebruiker terug.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "user.checkAuthentication",
           "params": {
               "sessionid": "673b8ba11562a35da902c66cf5c23fa2"
           },
           "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",
               "ts_provisioned": "0",
               "type": 3,
               "userip": "127.0.0.1",
               "debug_mode": 0,
               "gui_access": "0",
               "deprovisioned": false,
               "auth_type": 0,
               "sessionid": "673b8ba11562a35da902c66cf5c23fa2",
               "secret": "0e329b933e46984e49a5c1051ecd0751"
           },
           "id": 1
       }

Controleer authenticatie met behulp van een API-token

Controleer een gebruikerssessie met behulp van het API-token van de gebruiker en geef aanvullende informatie over de gebruiker terug.