Documentation
Table of Contents
Objeto de usuario
Los siguientes objetos están directamente relacionados con la API user.
Usuario
El objeto usuario tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| userid | ID | ID del usuario. Comportamiento de la propiedad: - solo lectura - requerido para operaciones de actualización |
| username | string | Nombre del usuario. Comportamiento de la propiedad: - requerido para operaciones de creación - solo lectura para usuarios aprovisionados si el usuario está vinculado a un directorio de usuarios ( userdirectoryid tiene un valor válido distinto de "0"), y el estado de aprovisionamiento del directorio de usuarios está habilitado (provision_status del objeto Directorio de usuarios está establecido en "1"), y el estado de autenticación de todo el aprovisionamiento LDAP o SAML está habilitado (ldap_jit_status del objeto Autenticación está establecido en "Habilitado para IdP LDAP configurados" o saml_jit_status del objeto Autenticación está establecido en "Habilitado para IdP SAML configurados") |
| passwd | string | Contraseña del usuario. El valor de este parámetro puede ser una cadena vacía si el usuario está vinculado a un directorio de usuarios. Comportamiento de la propiedad: - solo escritura |
| roleid | ID | ID del rol del usuario. Tenga en cuenta que los usuarios sin un rol solo pueden iniciar sesión en Zabbix utilizando autenticación LDAP o SAML, siempre que su información LDAP/SAML coincida con las asignaciones de grupos de usuarios configuradas en Zabbix. |
| attempt_clock | timestamp | Hora del último intento fallido de inicio de sesión. Comportamiento de la propiedad: - solo lectura |
| attempt_failed | integer | Cantidad reciente de intentos fallidos de inicio de sesión. Comportamiento de la propiedad: - solo lectura |
| attempt_ip | string | Dirección IP desde donde provino el último intento fallido de inicio de sesión. Comportamiento de la propiedad: - solo lectura |
| autologin | integer | Si se habilita el inicio de sesión automático. Valores posibles: 0 - (por defecto) inicio de sesión automático deshabilitado; 1 - inicio de sesión automático habilitado. |
| autologout | string | Duración de la sesión del usuario. Acepta segundos y unidad de tiempo con sufijo. Si se establece en 0s, la sesión nunca expirará. Por defecto: 15m. |
| lang | string | Código de idioma del usuario, por ejemplo, es_ES.Por defecto: default - predeterminado del sistema. |
| name | string | Nombre del usuario. |
| 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. Comportamiento de la propiedad: - solo lectura |
| refresh | string | Período de actualización automática. Acepta segundos o unidad de tiempo con sufijo (por ejemplo, 30s, 90s, 1m, 1h). Por defecto: 30s. |
| rows_per_page | integer | Cantidad de filas de objetos a mostrar por página. Por defecto: 50. |
| surname | string | Apellido del usuario. |
| theme | string | Tema del usuario. Valores posibles: default - (por defecto) predeterminado del sistema;blue-theme - Azul;dark-theme - Oscuro. |
| ts_provisioned | timestamp | Hora en que se realizó la última operación de aprovisionamiento. Comportamiento de la propiedad: - solo lectura - compatible para usuarios de tipo Super admin (desde Zabbix 7.0.9) |
| url | string | URL de la página a la que redirigir al usuario después de iniciar sesión. |
| userdirectoryid | ID | ID del directorio de usuarios al que está vinculado el usuario. Se utiliza para aprovisionamiento (creación o actualización), así como para iniciar sesión de un usuario vinculado a un directorio de usuarios. Para las operaciones de inicio de sesión, el valor de esta propiedad tendrá prioridad sobre la propiedad userdirectoryid de los grupos de usuarios a los que pertenece el usuario.Por defecto: 0. Comportamiento de la propiedad: - solo lectura - compatible para usuarios de tipo Super admin (desde Zabbix 7.0.9) |
| timezone | string | Zona horaria del usuario, por ejemplo, Europe/Madrid, UTC.Por defecto: default - predeterminado del sistema.Para la lista completa de zonas horarias compatibles, consulte la documentación de PHP. |
Medios
El objeto de medios tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| mediaid | ID | ID del medio del usuario. Comportamiento de la propiedad: - solo lectura |
| mediatypeid | ID | ID del tipo de medio utilizado por el medio del usuario. Comportamiento de la propiedad: - requerido |
| sendto | string/array | Dirección, nombre de usuario u otro identificador del destinatario. Si el type del Tipo de medio está establecido en "Correo electrónico", los valores se representan como un array. Para otros tipos de Tipos de medio, el valor se representa como una cadena.Comportamiento de la propiedad: - requerido |
| active | integer | Indica si el medio está habilitado. Valores posibles: 0 - (por defecto) habilitado; 1 - deshabilitado. |
| severity | integer | Gravedades de disparador sobre las que enviar notificaciones. Valores posibles de máscara de bits: 1 - No clasificado; 2 - Información; 4 - Advertencia; 8 - Media; 16 - Alta; 32 - Desastre. Este es un campo de máscara de bits; cualquier suma de los valores posibles de la máscara de bits es aceptable (por ejemplo, 48 para Media, Alta y Desastre). Por defecto: 63. |
| period | string | Tiempo en el que se pueden enviar las notificaciones como un período de tiempo o macros de usuario separadas por punto y coma. Por defecto: 1-7,00:00-24:00. |
| provisioned | integer | Indica si el usuario ha sido provisionado. Valores posibles: 0 - no provisionado; 1 - provisionado. Esta propiedad es compatible desde Zabbix 7.0.9. |
| userdirectory_mediaid | ID | ID de mapeo de medio de directorio de usuario para medios provisionados. Comportamiento de la propiedad: - solo lectura - compatible para usuarios de tipo Super admin (desde Zabbix 7.0.9) |