En esta página

Objeto usuario

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

Usuario

El objeto de usuario tiene las siguientes propiedades.

Property Type Description
userid ID ID del usuario.

Comportamiento de la propiedad:
- solo lectura
- obligatoria para operaciones de actualización
username string Nombre del usuario.

Comportamiento de la propiedad:
- obligatoria para operaciones de creación
- solo lectura para usuarios aprovisionados si el usuario está vinculado a un directorio de usuarios (userdirectoryid está establecido en un valor válido distinto de "0"), el estado de aprovisionamiento del directorio de usuarios está habilitado (provision_status del 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 del objeto de autenticación está establecido en "Enabled for configured LDAP IdPs" o saml_jit_status del objeto de autenticación está establecido en "Enabled for configured SAML IdPs")
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 mediante la 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 de inicio de sesión fallido.

Comportamiento de la propiedad:
- solo lectura
attempt_failed integer Cantidad de intentos recientes de inicio de sesión fallidos.

Comportamiento de la propiedad:
- solo lectura
attempt_ip string Dirección IP desde la que se realizó el último intento de inicio de sesión fallido.

Comportamiento de la propiedad:
- solo lectura
autologin integer Indica 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 Duración de la sesión del usuario. Acepta un número de segundos (por ejemplo, 1, 60, 300) o un valor con un sufijo de tiempo (por ejemplo, 30s, 1m, 2h). Si se establece en 0s, la sesión nunca caducará.

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

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

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

Comportamiento de la propiedad:
- solo lectura
refresh string Período de actualización automática. Acepta un número de segundos (por ejemplo, 1, 60, 300) o un valor con un sufijo de tiempo (por ejemplo, 30s, 1m, 1h).

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

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

Valores posibles:
default - (predeterminado) valor predeterminado del sistema;
blue-theme - Azul;
blue-classic-theme - Azul (clásico);
dark-theme - Oscuro;
dark-blue-theme - Azul oscuro;
dark-classic-theme - Oscuro (clásico);
hc-light - Claro de alto contraste;
hc-dark - Oscuro de alto contraste.
ts_provisioned timestamp Hora en la que se realizó la última operación de aprovisionamiento.

Comportamiento de la propiedad:
- solo lectura
- compatible con usuarios de tipo Super admin
url string URL de la página a la que se 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 el aprovisionamiento (creación o actualización), así como para iniciar sesión con 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.

Predeterminado: 0.

Comportamiento de la propiedad:
- solo lectura
- compatible con usuarios de tipo Super admin
timezone string Zona horaria del usuario, por ejemplo, Europe/London, UTC.

Predeterminado: default - valor predeterminado del sistema.

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

Medios

El objeto de medios tiene las siguientes propiedades.

Property Type Description
mediaid ID ID de los medios del usuario.

Comportamiento de la propiedad:
- solo lectura
mediatypeid ID ID del tipo de medio utilizado por los medios del usuario.

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á establecido en "Email" o "Push", los valores se representan como una matriz. Para "Push", la matriz puede contener un comodín (*) o uno o más ID de dispositivos móviles.

Si type de Tipo de medio está establecido en "Script", "SMS" o "Webhook", el valor se representa como una cadena.

Comportamiento de la propiedad:
- obligatorio
active integer Indica si los medios están habilitados.

Valores posibles:
0 - (predeterminado) habilitados;
1 - deshabilitados.
severity integer Gravedades de los trigger sobre las que se deben enviar 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 Hora en la que se pueden enviar las notificaciones, como un período de tiempo o macros de usuario separadas por un 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.
userdirectory_mediaid ID ID de asignación de medios del directorio de usuarios para los medios aprovisionados.

Comportamiento de la propiedad:
- solo lectura
- compatible con usuarios de tipo Super admin