user.checkAuthentication

Descrição

object user.checkAuthentication

Este método verifica e prolonga a sessão do usuário.

Chamar o método user.checkAuthentication usando o parâmetro sessionid prolonga a sessão do usuário por padrão.

Parâmetros

O método aceita os seguintes parâmetros.

Parâmetro	Tipo	Descrição
extend	boolean	Se deve prolongar a sessão do usuário. Valor padrão: "true". Definir o valor como "false" permite verificar a sessão do usuário sem prolongá-la. Comportamento do parâmetro: - suportado se `sessionid` estiver definido
sessionid	string	Token de autenticação do usuário. Comportamento do parâmetro: - obrigatório se `token` não estiver definido
secret	string	String aleatória de 32 caracteres. É gerada no login do usuário.
token	string	Token de API do usuário. Comportamento do parâmetro: - obrigatório se `sessionid` não estiver definido

Valores de retorno

(object) Retorna um objeto contendo informações sobre o usuário.

Além das propriedades padrão do usuário, as seguintes informações são retornadas.

Propriedade	Tipo	Descrição
auth_type	integer	Autenticação padrão para o usuário. Consulte a propriedade `authentication_type` do objeto Authentication para uma lista de valores possíveis.
debug_mode	integer	Se o modo de depuração está habilitado ou desabilitado para o usuário. Consulte a propriedade `debug_mode` do objeto User group para uma lista de valores possíveis.
deprovisioned	boolean	Se o usuário pertence a um grupo de usuários desprovisionados.
gui_access	string	Método de autenticação do usuário no frontend. Consulte a propriedade `gui_access` do objeto User group para uma lista de valores possíveis.
secret	string	String aleatória de 32 caracteres. É gerada no login do usuário. A propriedade `secret` não é retornada se a sessão do usuário for verificada usando um token de API.
sessionid	string	Token de autenticação, que deve ser usado nas próximas requisições da API. A propriedade `sessionid` não é retornada se a sessão do usuário for verificada usando um token de API.
type	integer	Tipo de usuário. Consulte a propriedade `type` do objeto Role para uma lista de valores possíveis.
userip	string	Endereço IP do usuário.

Exemplos

Verificar autenticação usando o token de autenticação

Verifique e prolongue uma sessão de usuário usando o token de autenticação do usuário e retorne informações adicionais sobre o usuário.

Requisição:

{
           "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",
               "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 autenticação usando o token da API

Verifique uma sessão de usuário usando o token da API do usuário e retorne informações adicionais sobre o usuário.