Table of Contents
>Usuário object
Os objetos a seguir estão diretamente relacionados aouser API.
Usuário
O objeto do usuário tem as seguintes propriedades:
| Propriedade | Tipo | Descrição |
|---|---|---|
| userid | string | (aleatoriamente) ID do usuário. |
| username (requisitado) |
string | Nome do usuário. |
| roleid (requisitado) |
string | A ID do papel do usuário. |
| attempt_clock | timestamp | (aleatoriamente) Horário da última tentativa de login. |
| attempt_failed | integer | (aleatoriamente) Número de tentativa de login sem sucesso recente. |
| attempt_ip | string | (aleatoriamente) Endereço do IP da última tentativa de login sem sucesso. |
| autologin | integer | Se permitir o auto-login. Possível valores: 0 - (padrão) auto-login desabilitado; 1 - auto-login habilitado. |
| autologout | string | Tempo de sessão do usuário. Aceita segundos e unidade de tempo com sufixos seconds and time. Se for 0s, a sessão nunca irá expirar. Padrão: 15m. |
| lang | string | Código da linguagem do usuário, por exemplo, en_GB.Padrão: default - padrão do sistema. |
| name | string | Nome do usuário. |
| refresh | string | Período de atualização automática. Aceita segundos e unidade de tempo com sufixos (e.g., 30s, 90s, 1m, 1h). Padrão: 30s. |
| rows_per_page | integer | Quantidade de linhas por página. Padrão: 50. |
| surname | string | Sobrenome do usuário. |
| theme | string | Tema do usuário. Valores possíveis: default - (padrão) padrão do sistema;blue-theme - Azul;dark-theme - Escuro. |
| url | string | Redirecionamento da URL da página depois do usuário fazer log in. |
| timezone | string | Fuso horário do usuário, por exemplo, Europe/London, UTC.Padrão: default - padrão do sistema.Para a lista completa dos fusos horários por favor recorrer a PHP documentation. |
| alias (descontinuado) |
string | Esta propriedade é descontinuada, por favor use username ao invés de.Usuário alias. |
Note que para alguns métodos (update, delete) a combinação do parâmetro requisitado/opcional é diferente.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 or time unit with suffix (e.g., 30s, 90s, 1m, 1h).
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.| |alias
(deprecated)|string|This property is deprecated, please use username instead.
User alias.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
Mídia
O objeto mídia tem as seguintes propriedades:
| Propriedade | Tipo | Descrição |
|---|---|---|
| mediatypeid (required) |
string | ID do tipo de mídia usado pela mídia. |
| sendto (required) |
string/array | Endereço, nome do usuário ou outro identificador do recebedor. Se o tipo Media type for e-mail, valores serão apresentados como array. Por outros tipos de Media types, o valor é apresentado como uma string. |
| active | integer | Se a mídia estiver habilitada. Valores possíveis: 0 - (padrão) habilitado; 1 - desabilitado. |
| severity | integer | Severidades de Trigger para enviar notificações sobre. Severidade são armazenadas de forma binária, com cada bit representando a severidade correspondente. Por exemplo, 12 em binário é 1100, e isso significa que as notificações serão enviadas a partir de triggers com severidade de aviso e média. Consultar trigger object page para obter uma lista de severidades de trigger suportadas. Padrão: 63 |
| period | string | Horário quando as notificações podem ser enviadas como um time period ou macros do usuário separados por ponto e vírgula. Padrão: 1-7,00:00-24:00 |