This is the documentation page for an unsupported version of Zabbix.
Is this not what you were looking for? Switch to the current version or choose one from the drop-down menu.



object user.checkAuthentication

This method checks and prolongs user session.

Calling the user.checkAuthentication method with the parameter sessionid set prolongs user session by default.


The method accepts the following parameters.

Parameter Type Description
extend boolean Whether to prolong the user session.

Default value: "true". Setting the value to "false" allows to check the user session without prolonging it.

Used if sessionid is set.
sessionid string User session ID.

Required if token is not set.
token string User API token.

Required if sessionid is not set.

Return values

(object) Returns an object containing information about user.



           "jsonrpc": "2.0",
           "method": "user.checkAuthentication",
           "params": {
               "sessionid": "673b8ba11562a35da902c66cf5c23fa2"
           "id": 1


           "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": "",
               "attempt_clock": "1355919038",
               "rows_per_page": "50",
               "timezone": "Europe/Riga",
               "roleid": "3",
               "type": 3,
               "sessionid": "673b8ba11562a35da902c66cf5c23fa2",
               "debug_mode": 0,
               "userip": "",
               "gui_access": 0,
               "userdirectoryid": 0
           "id": 1

Response is similar to User.login call response with "userData" parameter set to true (the difference is that user data is retrieved by session id and not by username / password).


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