[comment]: # aside: 1

[comment]: # ({8f026b4a-0834cf88})
# Objeto de usuário

Os seguintes objetos estão diretamente relacionados à API de `user`.

[comment]: # ({/8f026b4a-0834cf88})

[comment]: # ({730822db-0ecc45be})
### Usuário

O objeto usuário possui as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|userid|ID|ID do usuário.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*<br>- *obrigatório* para operações de atualização|
|username|string|Nome do usuário.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* para operações de criação<br>- *somente leitura* para [usuários provisionados](/manual/web_interface/frontend_sections/users/authentication#default-authentication) se o usuário estiver vinculado a um [diretório de usuários](/manual/api/reference/userdirectory/object) (`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](/manual/api/reference/userdirectory/object#userdirectory) 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](/manual/api/reference/authentication/object#authentication) definido como "Habilitado para IdPs LDAP configurados" ou `saml_jit_status` do [objeto Autenticação](/manual/api/reference/authentication/object#authentication) definido como "Habilitado para IdPs SAML configurados")|
|passwd|string|Senha do usuário.<br><br>O valor deste parâmetro pode ser uma string vazia se o usuário estiver vinculado a um [diretório de usuários](/manual/api/reference/userdirectory/object).<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente gravação*|
|roleid|ID|ID da função do usuário.<br><br>Observe que usuários sem função podem fazer login no Zabbix apenas usando autenticação [LDAP](/manual/web_interface/frontend_sections/users/authentication/ldap) ou [SAML](/manual/web_interface/frontend_sections/users/authentication/saml), desde que suas informações LDAP/SAML correspondam aos mapeamentos de grupos de usuários configurados no Zabbix.|
|attempt\_clock|timestamp|Hora da última tentativa de login malsucedida.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*|
|attempt\_failed|integer|Contagem recente de tentativas de login malsucedidas.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*|
|attempt\_ip|string|Endereço IP de onde veio a última tentativa de login malsucedida.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*|
|autologin|integer|Se o login automático está habilitado.<br><br>Valores possíveis:<br>0 - *(padrão)* login automático desabilitado;<br>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á.<br><br>Padrão: 15m.|
|lang|string|Código do idioma do usuário, por exemplo, `pt_BR`.<br><br>Padrão: `default` - padrão do sistema.|
|name|string|Nome do usuário.|
|provisioned|integer|Se o usuário foi [provisionado](/manual/api/reference/user/provision).<br><br>Valores possíveis:<br>0 - não provisionado;<br>1 - provisionado.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *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).<br><br>Padrão: 30s.|
|rows\_per\_page|integer|Quantidade de linhas de objetos para mostrar por página.<br><br>Padrão: 50.|
|surname|string|Sobrenome do usuário.|
|theme|string|Tema do usuário.<br><br>Valores possíveis:<br>`default` - *(padrão)* padrão do sistema;<br>`blue-theme` - Azul;<br>`dark-theme` - Escuro;<br>`hc-light` - Alto contraste claro;<br>`hc-dark` - Alto contraste escuro.|
|ts_provisioned|timestamp|Hora em que a última operação de [provisionamento](/manual/api/reference/user/provision) foi realizada.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*<br>- *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](/manual/api/reference/userdirectory/object) ao qual o usuário está vinculado.<br><br>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.<br><br>Para operações de login, o valor desta propriedade terá prioridade sobre a propriedade `userdirectoryid` dos [grupos de usuários](/manual/api/reference/usergroup/object#user-group) aos quais o usuário pertence.<br><br>Padrão: 0.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*<br>- *suportado* para usuários do tipo *Super admin*|
|timezone|string|Fuso horário do usuário, por exemplo, `Europe/London`, `UTC`.<br><br>Padrão: `default` - padrão do sistema.<br><br>Para a lista completa de fusos horários suportados, consulte a [documentação do PHP](https://www.php.net/manual/pt_BR/timezones.php).|

[comment]: # ({/730822db-0ecc45be})

[comment]: # ({e65af01e-1ad487be})
### Mídia

O objeto mídia possui as seguintes propriedades.

|Propriedade|Tipo|Descrição|
|--|--|------|
|mediaid|ID|ID da mídia do usuário.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*|
|mediatypeid|ID|ID do tipo de mídia usada pela mídia do usuário.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório*|
|sendto|string/array|Endereço, nome de usuário ou outro identificador do destinatário.<br><br>Se o `type` do [Tipo de mídia](/manual/api/reference/mediatype/object#mediatype) estiver definido como "Email", os valores são representados como array. Para outros tipos de [Tipos de mídia](/manual/api/reference/mediatype/object#mediatype), o valor é representado como uma string.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório*|
|active|integer|Se a mídia está habilitada.<br><br>Valores possíveis:<br>0 - *(padrão)* habilitada;<br>1 - desabilitada.|
|severity|integer|Severidades de trigger para enviar notificações.<br><br>Valores possíveis de bitmap:<br>1 - Não classificado;<br>2 - Informação;<br>4 - Aviso;<br>8 - Médio;<br>16 - Alto;<br>32 - Desastre.<br><br>Este é um campo de máscara de bits; qualquer soma dos valores possíveis de bitmap é aceitável (por exemplo, 48 para Médio, Alto e Desastre).<br><br>Padrão: 63.|
|period|string|Horário em que as notificações podem ser enviadas como um [período de tempo](/manual/appendix/time_period) ou macros de usuário separadas por ponto e vírgula.<br><br>Padrão: 1-7,00:00-24:00.|
|provisioned|integer|Se o usuário foi [provisionado](/manual/api/reference/user/provision).<br><br>Valores possíveis:<br>0 - não provisionado;<br>1 - provisionado.|
|userdirectory_mediaid|ID|ID de mapeamento de mídia do diretório de usuários para mídia provisionada.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*<br>- *suportado* para usuários do tipo *Super admin*|

[comment]: # ({/e65af01e-1ad487be})