user.checkAuthentication

Descripció

object user.checkAuthentication

Aquest mètode verifica i perllonga la sessió d'usuari.

La crida al mètode user.checkAuthentication amb el paràmetre establert sessionidperllonga per defecte la sessió d'usuari.

Paràmetres

El mètode admet els paràmetres següents.

Paràmetres	Tipus	Descripció
extend	boolean	Si es vol perllongar la sessió d'usuari. Valor per defecte: "true". Definir el valor a "false" permet verificar la sessió sense perllongar la seva durada. s'empra si s'ha esablert `sessionid`.
sessionid	string	Identificador de la sessió d'usuari. Obligatori si no s'ha establert `token`.
token	string	API token d'usuari. Obligatori si `sessionid` no s'ha definit.

Valors de retorn

(object) Retorna un objecte continguent informació de l'usuari.

Exemples

Petició:

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

Resposta:

{
           "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
       }

La resposta és similar a la resposta de la crida User.login amb el paràmetre "userData" establert a cert (amb la diferpencia que les dades d'usuari són retornades per l'ID de la sesió i no pas per nom d'usuari i paraula de pas).

Font

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

Documentation