user.checkAuthentication

Descripción

object user.checkAuthentication

Este método comprueba y prolonga la sesión del usuario.

Llamar al método user.checkAuthentication usando el parámetro sessionid prolonga la sesión del usuario de forma predeterminada.

Parámetros

El método acepta los siguientes parámetros.

Parámetro	Tipo	Descripción
extend	booleano	Si se debe prolongar la sesión del usuario. Valor predeterminado: "verdadero". Establecer el valor en "falso" permite verificar la sesión del usuario sin prolongarla. <br >Comportamiento de parámetros: - compatible si se establece `sessionid`
sessionid	cadena	Token de autenticación del usuario. Comportamiento de parámetros: - obligatorio si `token` no está configurado
secret	cadena	Cadena aleatoria de 32 caracteres. Se genera al iniciar sesión el usuario.
token	cadena	Token de API del usuario. Comportamiento de parámetros: - obligatorio si `sessionid` no está configurado

Valores de retorno

(objeto) Devuelve un objeto que contiene información sobre el usuario.

Además de las propiedades estándar de [usuario] (object#user), se devuelve la siguiente información.

Propiedad	Tipo	Descripción
auth_type	entero	Autenticación predeterminada para el usuario. Consulte la propiedad `authentication_type` del objeto de autenticación para obtener una lista de valores posibles.
debug_mode	entero	Si el modo de depuración está habilitado o deshabilitado para el usuario. Consulte la propiedad `debug_mode` del objeto de grupo de usuarios para obtener una lista de valores posibles.
deprovisioned	booleano	Si el usuario pertenece a un grupo de usuarios desaprovisionados.
gui_access	stringcadenaMétodo de autenticación del usuario en la interfaz de usuario. Consulte la propiedad `gui_access` del objeto de grupo de usuarios para obtener un lista de valores posibles.
secret	cadena	Cadena aleatoria de 32 caracteres. Se genera al iniciar sesión el usuario. La propiedad `secret` no se devuelve si la sesión del usuario se verifica mediante un token API.
sessionid	cadena	Token de autenticación, que debe usarse en las siguientes solicitudes API. La propiedad `sessionid` no se devuelve si la sesión del usuario se verifica usando un token API.
type	enterio	Tipo de usuario. Consulte la propiedad `type` del objeto de rol para obtener una lista de valores posibles.
userip	cadena	Dirección IP del usuario.

Ejemplos

Verificar la autenticación mediante el token de autenticación

Verifique y prolongue una sesión de usuario utilizando el token de autenticación de usuario y devuelva información adicional sobre el usuario.

Solicitud:

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

Respuesta:

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

Verificar la autenticación mediante el token API

Verifique una sesión de usuario utilizando el token API de usuario y devuelva información adicional sobre el usuario.