En esta página

Objeto usuario

Los siguientes objetos están directamente relacionados con la API de usuario.

User

El objeto user tiene las siguientes propiedades.

Property Type Description
userid ID ID del user.

Property behavior:
- solo lectura
- obligatorio para operaciones de actualización
username string Nombre del user.

Property behavior:
- obligatorio para operaciones de creación
- solo lectura para provisioned users si el user está vinculado a un user directory (userdirectoryid está establecido en un valor válido distinto de "0"), y el estado de aprovisionamiento del user directory está habilitado (provision_status del User directory object está establecido en "1"), y el estado de autenticación de todo el aprovisionamiento LDAP o SAML está habilitado (ldap_jit_status del Authentication object está establecido en "Enabled for configured LDAP IdPs" o saml_jit_status del Authentication object está establecido en "Enabled for configured SAML IdPs")
passwd string Contraseña del user.

El valor de este parámetro puede ser una cadena vacía si el user está vinculado a un user directory.

Property behavior:
- solo escritura
roleid ID ID del rol del user.

Tenga en cuenta que los users sin un rol solo pueden iniciar sesión en Zabbix usando autenticación LDAP o SAML, siempre que su información LDAP/SAML coincida con las asignaciones de grupos de users configuradas en Zabbix.
attempt_clock timestamp Hora del último intento de inicio de sesión fallido.

Property behavior:
- solo lectura
attempt_failed integer Cantidad de intentos recientes de inicio de sesión fallidos.

Property behavior:
- solo lectura
attempt_ip string Dirección IP desde la que se produjo el último intento de inicio de sesión fallido.

Property behavior:
- solo lectura
autologin integer Indica si se habilita el inicio de sesión automático.

Valores posibles:
0 - (predeterminado) inicio de sesión automático deshabilitado;
1 - inicio de sesión automático habilitado.
autologout string Tiempo de vida de la sesión del user. Acepta segundos y una unidad de tiempo con sufijo. Si se establece en 0s, la sesión nunca expirará.

Predeterminado: 15m.
lang string Código de idioma del idioma del user, por ejemplo, en_US.

Predeterminado: default - valor predeterminado del sistema.
name string Nombre del user.
provisioned integer Indica si el user ha sido provisioned.

Valores posibles:
0 - no provisioned;
1 - provisioned.

Esta propiedad es compatible desde Zabbix 7.0.9.

Property behavior:
- solo lectura
refresh string Período de actualización automática. Acepta segundos o una unidad de tiempo con sufijo (por ejemplo, 30s, 90s, 1m, 1h).

Predeterminado: 30s.
rows_per_page integer Cantidad de filas del objeto que se mostrarán por página.

Predeterminado: 50.
surname string Apellido del user.
theme string Tema del user.

Valores posibles:
default - (predeterminado) valor predeterminado del sistema;
blue-theme - Azul;
dark-theme - Oscuro;
hc-light - Alto contraste claro;
hc-dark - Alto contraste oscuro.
ts_provisioned timestamp Hora en que se realizó la última operación de provisioning.

Property behavior:
- solo lectura
- compatible para users de tipo Super admin (desde Zabbix 7.0.9)
url string URL de la página a la que se redirigirá al user después de iniciar sesión.
userdirectoryid ID ID del user directory al que está vinculado el user.

Se usa para el aprovisionamiento (creación o actualización), así como para iniciar sesión de un user vinculado a un user directory.

Para las operaciones de inicio de sesión, el valor de esta propiedad tendrá prioridad sobre la propiedad userdirectoryid de los user groups a los que pertenece el user.

Predeterminado: 0.

Property behavior:
- solo lectura
- compatible para users de tipo Super admin (desde Zabbix 7.0.9)
timezone string Zona horaria del user, por ejemplo, Europe/London, UTC.

Predeterminado: default - valor predeterminado del sistema.

Para la lista completa de zonas horarias compatibles, consulte la documentación de PHP.

Media

El objeto media tiene las siguientes propiedades.

Property Type Description
mediaid ID ID del media del usuario.

Comportamiento de la propiedad:
- solo lectura
mediatypeid ID ID del tipo de media utilizado por el media del usuario.

Comportamiento de la propiedad:
- obligatorio
sendto string/array Dirección, nombre de usuario u otro identificador del destinatario.

Si type de Media type está establecido en "Email", los valores se representan como array. Para otros tipos de Media types, el valor se representa como una cadena.

Comportamiento de la propiedad:
- obligatorio
active integer Indica si el media está habilitado.

Valores posibles:
0 - (predeterminado) habilitado;
1 - deshabilitado.
severity integer Severidades de trigger sobre las que se enviarán notificaciones.

Valores de mapa de bits posibles:
1 - No clasificado;
2 - Información;
4 - Advertencia;
8 - Promedio;
16 - Alto;
32 - Desastre.

Este es un campo de máscara de bits; se acepta cualquier suma de los valores de mapa de bits posibles (por ejemplo, 48 para Promedio, Alto y Desastre).

Predeterminado: 63.
period string Momento en que las notificaciones pueden enviarse como un período de tiempo o macros de usuario separados por punto y coma.

Predeterminado: 1-7,00:00-24:00.
provisioned integer Indica si el usuario ha sido aprovisionado.

Valores posibles:
0 - no aprovisionado;
1 - aprovisionado.

Esta propiedad es compatible desde Zabbix 7.0.9.
userdirectory_mediaid ID ID de asignación de media del directorio de usuarios para media aprovisionado.

Comportamiento de la propiedad:
- solo lectura
- compatible para usuarios de tipo Super admin (desde Zabbix 7.0.9)