Documentation
Table of Contents
> Objeto de usuario
Los siguientes objetos están directamente relacionados con la API user.
User
The user object has the following properties.
| Property | Type | Description |
|---|---|---|
| userid | string | (readonly) ID of the user. |
| username (required) |
string | User name. |
| attempt_clock | timestamp | (readonly) Time of the last unsuccessful login attempt. |
| attempt_failed | integer | (readonly) Recent failed login attempt count. |
| attempt_ip | string | (readonly) IP address from where the last unsuccessful login attempt came from. |
| autologin | integer | Whether to enable auto-login. Possible values: 0 - (default) auto-login disabled; 1 - auto-login enabled. |
| autologout | string | User session life time. Accepts seconds and time unit with suffix. If set to 0s, the session will never expire. Default: 15m. |
| lang | string | Language code of the user's language, for example, en_GB.Default: default - system default. |
| name | string | Name of the user. |
| refresh | string | Automatic refresh period. Accepts seconds and time unit with suffix. Default: 30s. |
| rows_per_page | integer | Amount of object rows to show per page. Default: 50. |
| surname | string | Surname of the user. |
| theme | string | User's theme. Possible values: default - (default) system default;blue-theme - Blue;dark-theme - Dark. |
| url | string | URL of the page to redirect the user to after logging in. |
| timezone | string | User's time zone, for example, Europe/London, UTC.Default: default - system default.For the full list of supported time zones please refer to PHP documentation. |
| roleid (required) |
string | Role ID of the user. |
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 |