Documentation
Table of Contents
Objeto de usuario
Los siguientes objetos están directamente relacionados con la API user.
Usuario
El objeto de usuario tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| userid | ID | ID del usuario. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualización |
| nombre de usuario | cadena | Nombre de usuario. Comportamiento de la propiedad: - obligatorio para operaciones de creación - solo lectura para usuarios aprovisionados si el usuario está vinculado a un directorio de usuarios ( userdirectoryid está configurado a un valor válido que no sea "0") y el estado de aprovisionamiento del directorio de usuarios está habilitado (provision_status de objeto de 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 de Objeto de autenticación está configurado en "Habilitado para IdP LDAP configurados" o saml_jit_status de Objeto de autenticación está configurado 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.<br > Comportamiento de la propiedad: - solo escritura |
| roleid | ID | ID del rol del usuario. Tenga en cuenta que los usuarios sin un rol pueden iniciar sesión en Zabbix solo usando LDAP o Autenticación SAML, siempre que su información LDAP/SAML coincida con las asignaciones de grupos de usuarios configuradas en Zabbix. |
| attempt_clock | marca de tiempo | Hora del último intento fallido de inicio de sesión. Comportamiento de la propiedad: - solo lectura |
| attempt_failed | integer | Recuento de intentos de inicio de sesión fallidos recientes. Comportamiento de la propiedad: - solo lectura |
| attempt_ip | cadena | 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 debe habilitar 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 usuario. Acepta segundos y unidad de tiempo con sufijo. Si se establece en 0, la sesión nunca caducará. Predeterminado: 15 min. |
| lang | string | Código de idioma del idioma del usuario, por ejemplo, en_GB.Predeterminado: default - predeterminado del sistema. |
| nombre | cadena | Nombre del usuario. |
| refresh | string | Período de actualización automática. Acepta segundos o unidades de tiempo con sufijo (p. ej., 30 s, 90 s, 1 m, 1 h). Predeterminado: 30 s. |
| rows_per_page | integer | Cantidad de filas de objetos que se mostrarán por página. Predeterminado: 50. |
| apellido | cadena | Apellido del usuario. |
| tema | cadena | Tema del usuario. Valores posibles: default - (default) sistema predeterminado;blue-theme - Azul;dark-theme - Oscuro. |
| ts_provisioned | marca de tiempo | Hora en la que se realizó la última operación de aprovisionamiento. Comportamiento de la propiedad : - solo lectura |
| url | cadena | 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 aprovisionar (crear o actualizar), así como para inicie sesión como usuario que está vinculado a un directorio de usuarios. Para operaciones de inicio de sesión, el valor de esta propiedad tendrá prioridad sobre la propiedad userdirectoryid de grupos de usuarios al que pertenece el usuario.Valor predeterminado: 0. Comportamiento de la propiedad: - leer -sólo |
| zona horaria | cadena | Zona horaria del usuario, por ejemplo, Europa/Londres, UTC.Predeterminado: default - predeterminado del sistema.Para ver la lista completa de horarios admitidos zonas, consulte la documentación PHP. |
Medios
El objeto multimedia tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| mediatypeid | ID | ID del tipo de medio utilizado por el medio. Comportamiento de la propiedad: - obligatorio |
| sendto | string/array | Dirección, nombre de usuario u otro identificador del destinatario. Si type de Tipo de medio está configurado en "Correo electrónico", los valores se representan como una matriz. Para otros tipos de Tipos de medios, el valor se representa como una cadena.Comportamiento de la propiedad: - obligatorio |
| activo | entero | Si los medios están habilitados. Valores posibles: 0 - (predeterminado) habilitado; 1 - deshabilitado. |
| gravedad | integer | Gravedades de activación sobre las que enviar notificaciones. Las gravedades se almacenan en formato binario y cada bit representa la gravedad correspondiente. Por ejemplo, "12" equivale a "1100" en binario y significa que las notificaciones se enviarán desde activadores con gravedades "advertencia" y "promedio". Consulte la página del objeto activador para obtener una lista de las gravedades de activación admitidas. Valor predeterminado: 63. |
| period | string | Hora en la que las notificaciones se pueden enviar como un período de tiempo o macros de usuario separadas por un punto y coma. Predeterminado: 1-7,00:00- 24:00. |
| userdirectory_mediaid | ID | ID de asignación de medios del directorio de usuarios para los medios aprovisionados. Comportamiento de la propiedad: - solo lectura |