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 | cadena | (sólo lectura) ID del usuario. |
| nombre de usuario (obligatorio) |
cadena | Nombre de usuario. |
| roleid (obligatorio) |
cadena | ID de rol del usuario. |
| attempt_clock | marca de tiempo | (solo lectura) Hora del último intento fallido de inicio de sesión. |
| intento_failed | integer | (sólo lectura) Recuento de intentos de inicio de sesión fallidos recientes. |
| attempt_ip | string | (readonly) Dirección IP desde donde provino el último intento fallido de inicio de sesión. |
| 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 m. |
| 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 (por ejemplo, 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. |
| url | cadena | URL de la página a la que redirigir al usuario después de iniciar sesión. |
| 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. |
| alias (deprecated) |
string | Esta propiedad está en desuso, utilice nombre de usuario en su lugar.Alias de usuario. |
Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros requeridos/opcionales es diferente.
Medios
El objeto media tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| mediatypeid (obligatorio) |
cadena | ID del tipo de medio utilizado por el medio. |
| sendto (obligatorio) |
string/array | Dirección, nombre de usuario u otro identificador del destinatario. Si el tipo de Tipo de medio es correo electrónico, los valores se representan como una matriz. Para otros tipos de Tipos de medios, el valor se representa como una cadena. |
| active | entero | Si el medio está habilitado. Valores posibles: 0 - (predeterminado) habilitado; 1 - deshabilitado. |
| severity | 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 advertencia de gravedad y promedio. Consulte la página del objeto trigger para obtener una lista de gravedades de iniciador admitidas. Predeterminado: 63 |
| period | cadena | 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 |