Table of Contents
Objeto de usuário
Os seguintes objetos estão diretamente relacionados à API de user.
Usuário
O objeto usuário possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| userid | ID | ID do usuário. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| username | string | Nome do usuário. Comportamento da propriedade: - obrigatório para operações de criação - somente leitura para usuários provisionados se o usuário estiver vinculado a um diretório de usuários ( userdirectoryid definido para um valor válido diferente de "0"), e o status de provisionamento do diretório de usuários estiver habilitado (provision_status do objeto Diretório de Usuários definido como "1"), e o status de autenticação de todo o provisionamento LDAP ou SAML estiver habilitado (ldap_jit_status do objeto Autenticação definido como "Habilitado para IdPs LDAP configurados" ou saml_jit_status do objeto Autenticação definido como "Habilitado para IdPs SAML configurados") |
| passwd | string | Senha do usuário. O valor deste parâmetro pode ser uma string vazia se o usuário estiver vinculado a um diretório de usuários. Comportamento da propriedade: - somente gravação |
| roleid | ID | ID do papel do usuário. Observe que usuários sem papel podem fazer login no Zabbix apenas usando autenticação LDAP ou SAML, desde que suas informações LDAP/SAML correspondam aos mapeamentos de grupos de usuários configurados no Zabbix. |
| attempt_clock | timestamp | Horário da última tentativa de login malsucedida. Comportamento da propriedade: - somente leitura |
| attempt_failed | integer | Contagem recente de tentativas de login malsucedidas. Comportamento da propriedade: - somente leitura |
| attempt_ip | string | Endereço IP de onde veio a última tentativa de login malsucedida. Comportamento da propriedade: - somente leitura |
| autologin | integer | Se o login automático está habilitado. Valores possíveis: 0 - (padrão) login automático desabilitado; 1 - login automático habilitado. |
| autologout | string | Tempo de vida da sessão do usuário. Aceita segundos e unidade de tempo com sufixo. Se definido como 0s, a sessão nunca expirará. Padrão: 15m. |
| lang | string | Código do idioma do usuário, por exemplo, pt_BR.Padrão: default - padrão do sistema. |
| name | string | Nome do usuário. |
| provisioned | integer | Se o usuário foi provisionado. Valores possíveis: 0 - não provisionado; 1 - provisionado. Comportamento da propriedade: - somente leitura |
| refresh | string | Período de atualização automática. Aceita segundos ou unidade de tempo com sufixo (por exemplo, 30s, 90s, 1m, 1h). Padrão: 30s. |
| rows_per_page | integer | Quantidade de linhas de objetos para mostrar por página. Padrão: 50. |
| surname | string | Sobrenome do usuário. |
| theme | string | Tema do usuário. Valores possíveis: default - (padrão) padrão do sistema;blue-theme - Azul;dark-theme - Escuro. |
| ts_provisioned | timestamp | Horário em que a última operação de provisionamento foi realizada. Comportamento da propriedade: - somente leitura - suportado para usuários do tipo Super admin |
| url | string | URL da página para redirecionar o usuário após o login. |
| userdirectoryid | ID | ID do diretório de usuários ao qual o usuário está vinculado. Usado para provisionamento (criação ou atualização), bem como para fazer login de um usuário vinculado a um diretório de usuários. Para operações de login, o valor desta propriedade terá prioridade sobre a propriedade userdirectoryid dos grupos de usuários aos quais o usuário pertence.Padrão: 0. Comportamento da propriedade: - somente leitura - suportado para usuários do tipo Super admin |
| timezone | string | Fuso horário do usuário, por exemplo, Europe/London, UTC.Padrão: default - padrão do sistema.Para a lista completa de fusos horários suportados, consulte a documentação do PHP. |
Mídia
O objeto mídia possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| mediaid | ID | ID da mídia do usuário. Comportamento da propriedade: - somente leitura |
| mediatypeid | ID | ID do tipo de mídia usada pela mídia do usuário. Comportamento da propriedade: - obrigatório |
| sendto | string/array | Endereço, nome de usuário ou outro identificador do destinatário. Se o type do Tipo de mídia estiver definido como "Email", os valores são representados como array. Para outros tipos de Tipos de mídia, o valor é representado como uma string.Comportamento da propriedade: - obrigatório |
| active | integer | Se a mídia está habilitada. Valores possíveis: 0 - (padrão) habilitada; 1 - desabilitada. |
| severity | integer | Severidades de trigger para enviar notificações. Valores possíveis de bitmap: 1 - Não classificado; 2 - Informação; 4 - Aviso; 8 - Médio; 16 - Alto; 32 - Desastre. Este é um campo de máscara de bits; qualquer soma dos valores possíveis é aceitável (por exemplo, 48 para Médio, Alto e Desastre). Padrão: 63. |
| period | string | Horário em que as notificações podem ser enviadas como um período de tempo ou macros de usuário separadas por ponto e vírgula. Padrão: 1-7,00:00-24:00. |
| provisioned | integer | Se o usuário foi provisionado. Valores possíveis: 0 - não provisionado; 1 - provisionado. |
| userdirectory_mediaid | ID | ID de mapeamento de mídia do diretório de usuários para mídia provisionada. Comportamento da propriedade: - somente leitura - suportado para usuários do tipo Super admin |