以下objects与userAPI直接相关。
用户
用户 object 具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| userid | string | (只读) 用户ID。 |
| username (required) |
string | 用户名。 |
| roleid (required) |
string | 用户角色ID。 |
| attempt_clock | timestamp | (只读) 最后一次登录失败尝试的时间。 |
| attempt_failed | integer | (只读) 最近登录失败尝试次数。 |
| attempt_ip | string | (只读) 最后一次登录失败尝试的IP地址。 |
| autologin | integer | 是否启用自动登录。 可能的值： 0 - (默认) 禁用自动登录； 1 - 启用自动登录。 |
| autologout | string | 用户会话生命周期。接受秒数和带后缀的时间单位。如果设置为0s，会话将永不过期。 默认值：15m。 |
| lang | string | 用户语言的语言代码，例如 en_US。默认值： default - 系统默认。 |
| name | string | 用户的名字。 |
| refresh | string | 自动刷新周期。接受秒数或带后缀的时间单位（例如，30s、90s、1m、1h）。 默认值：30s。 |
| rows_per_page | integer | 每页显示的 object 行数。 默认值：50。 |
| surname | string | 用户的姓氏。 |
| theme | string | 用户的主题。 可能的值： default - (默认) 系统默认；blue-theme - 蓝色；dark-theme - 深色。 |
| url | string | 用户登录后重定向到的页面URL。 |
| timezone | string | 用户的时区，例如 Europe/London、UTC。默认值： default - 系统默认。有关支持的时区完整列表，请参阅 PHP documentation。 |
| alias (deprecated) |
string | 此属性已弃用，请改用 username。用户 alias。 |
请注意，对于某些方法（更新、删除），必需/可选参数的组合是不同的。
媒介
媒体类型 object 具有以下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| mediatypeid (required) |
string | 媒体所使用的媒体类型ID。 |
| sendto (required) |
string/array | 收件人的地址、用户名或其他标识符。 如果媒介类型的类型是电子邮件，值将表示为array。对于其他类型的媒介类型，值将表示为string。 |
| active | integer | 媒体是否启用。 可能的值： 0 - （默认） 启用； 1 - 禁用。 |
| severity | integer | 发送通知的触发器严重性。 可能的位图值： 1 - 未分类； 2 - 信息； 4 - 警告； 8 - 一般； 16 - 高； 32 - 灾难。 这是一个位掩码字段；任何可能的位图值的总和都是可接受的（例如，48 表示一般、高和灾难）。 默认值：63。 |
| period | string | 可以发送通知的时间，作为time period或用户宏，用分号分隔。 默认值：1-7,00:00-24:00 |