user.checkAuthentication

Descripción

object user.checkAuthentication

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

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

Parámetros

El método acepta los siguientes parámetros.

Parámetro	Tipo	Descripción
extend	boolean	Indica si se debe prolongar la sesión del usuario. Valor por defecto: "true". Establecer el valor en "false" permite comprobar la sesión del usuario sin prolongarla. Comportamiento del parámetro: - soportado si se establece `sessionid`
sessionid	string	Token de autenticación del usuario. Comportamiento del parámetro: - obligatorio si no se establece `token`
secret	string	Cadena aleatoria de 32 caracteres. Se genera al iniciar sesión el usuario.
token	string	Token de API del usuario. Comportamiento del parámetro: - obligatorio si no se establece `sessionid`

Valores de retorno

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

Además de las propiedades estándar del usuario, se devuelve la siguiente información.

Propiedad	Tipo	Descripción
auth_type	integer	Autenticación predeterminada para el usuario. Consulte la propiedad `authentication_type` del objeto Authentication para ver una lista de valores posibles.
debug_mode	integer	Indica si el modo de depuración está habilitado o deshabilitado para el usuario. Consulte la propiedad `debug_mode` del objeto User group para ver una lista de valores posibles.
deprovisioned	boolean	Indica si el usuario pertenece a un grupo de usuarios desprovisionados.
gui_access	string	Método de autenticación del usuario en la interfaz web. Consulte la propiedad `gui_access` del objeto User group para ver una lista de valores posibles.
secret	string	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 comprueba utilizando un token de API.
sessionid	string	Token de autenticación, que debe utilizarse en las siguientes solicitudes de la API. La propiedad `sessionid` no se devuelve si la sesión del usuario se comprueba utilizando un token de API.
type	integer	Tipo de usuario. Consulte la propiedad `type` del objeto Role para ver una lista de valores posibles.
userip	string	Dirección IP del usuario.

Ejemplos

Comprobar la autenticación utilizando el token de autenticación

Comprueba y prolonga una sesión de usuario utilizando el token de autenticación del usuario, y devuelve 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
       }

Comprobar autenticación usando el token de API

Comprueba una sesión de usuario utilizando el token de API del usuario y devuelve información adicional sobre el usuario.