user.checkAuthentication

Descripció

object user.checkAuthentication

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

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

Paràmetres

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

Paràmetre Tipus Descripció
extend booleà Si s'ha de perllongar la sessió de l'usuari.

Valor per defecte: "cert".
Ajustar el valor a "fals" permet comprovar la sessió de l'usuari sense allargar-la.
<br >Comportament del paràmetre:
- admès si sessionid és establert
sessionid cadena Usuari token d'autenticació.

Comportament del paràmetre:
- obligatori si token no s'ha establert
secret cadena Cadena aleatòria de 32 caràcters. Es genera a l'inici de sessió de l'usuari.
token cadena Usuari token API.

Comportament del paràmetre:
- obligatori si sessionid no s'ha establert

Valors de retorn

(objecte) Retorna un objecte que conté informació sobre l'usuari.

A més de les propietats d'usuari estàndard, retorna la informació següent.

Propietat Tipus Descripció
auth_type enter Autenticació per defecte per a l'usuari.

Consulteu la propietat authentication_type de l'Objecte d'autenticació per a un llista de possibles valors.
debug_mode enter Si el mode de depuració està activat o desactivat per a l'usuari.

Consulteu la propietat debug_mode de l'Objecte del grup d'usuaris per obtindre una llista de possibles valors.
desprovisioned booleà Si l'usuari pertany a un grup d'usuaris desprovisionats.
gui_access cadena Mètode d'autenticació de l'usuari a la interfície.

Consulteu la propietat gui_access del llistat de possibles valors de l'objecte del grup d'usuaris.
secret cadena Cadena aleatòria de 32 caràcters. Es genera a l'inici de sessió de l'usuari.

La propietat secret no es retorna si la sessió de l'usuari es verifica amb un token API.
sessionid cadena Fitxa d'autenticació, que s'ha d'emprar a les peticions d'API següents.

La propietat sessionid no es retorna si la sessió de l'usuari es verifica amb un token d'API.
type enter Tipus d'usuari.

Consulteu la propietat type de l'objecte rol per obtindre una llista de valors possibles.
userip cadena Adreça IP de l'usuari.

Exemples

Comprovar l'autenticació emprant un token d'autenticació

Comproveu i allargueu una sessió d'usuari mitjançant el token d'autenticació d'usuari i retorneu informació addicional sobre l'usuari.

Petició:

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

Resposta:

{
           "jsonrpc": "2.0",
           "resultat": {
               "identificador d'usuari": "1",
               "username": "Administrador",
               "name": "Zabbix",
               "surname": "Administrador",
               "url": "",
               "autologin": "1",
               "autologout": "0",
               "lang": "ru_RU",
               "actualitzar": "0",
               "theme": "per defecte",
               "attempt_failed": "0",
               "attempt_ip": "127.0.0.1",
               "attempt_clock": "1355919038",
               "rows_per_page": "50",
               "timezone": "Europa/Riga",
               "roleid": "3",
               "userdirectoryid": "0",
               "ts_provisioned": "0",
               "type": 3,
               "userip": "127.0.0.1",
               "debug_mode": 0,
               "gui_access": "0",
               "desprovisioned": fals,
               "auth_type": 0,
               "sessionid": "673b8ba11562a35da902c66cf5c23fa2",
               "secret": "0e329b933e46984e49a5c1051ecd0751"
           },
           "id": 1
       }
Comprovar l'autenticació mitjançant el token API

Comproveu una sessió d'usuari mitjançant el token de l'API d'usuari i retorneu informació addicional sobre l'usuari.

Petició:

{
           "jsonrpc": "2.0",
           "method": "user.checkAuthentication",
           "params": {
               "token": "00aff470e07c12d707e50d98cfe39edef9e6ec349c14728dbdfbc8ddc5ea3eae"
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultat": {
               "usuerid": "1",
               "username": "Administrador",
               "name": "Zabbix",
               "surname": "Administrador",
               "url": "",
               "autologin": "1",
               "autologout": "0",
               "lang": "ru_RU",
               "update": "0",
               "theme": "per defecte",
               "attempt_failed": "0",
               "attempt_ip": "127.0.0.1",
               "attempt_clock": "1355919338",
               "rows_per_page": "50",
               "timezone": "Europa/Riga",
               "roleid": "3",
               "userdirectoryid": "0",
               "ts_provisioned": "0",
               "type": 3,
               "userip": "127.0.0.1",
               "debug_mode": 0,
               "gui_access": "1",
               "desprovisioned": fals,
               "auth_type": 0
           },
           "id": 1
       }

Font

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