用户 object
以下objects与user API直接相关.
用户
用户 object 具有以下属性.
| 属性 | 数据类型 | 描述 |
|---|---|---|
| userid | string | (只读) 用户ID. |
| username (required) |
string | 用户名. |
| roleid (required) |
string | 用户角色ID. |
| attempt_clock | timestamp | (只读) 最后一次失败的 login 尝试时间. |
| attempt_failed | integer | (只读) 近期失败的 login 尝试次数. |
| attempt_ip | string | (只读) 最后一次失败的 login 尝试来源IP地址. |
| autologin | integer | 是否启用自动login. 可选值: 0 - (默认) 禁用自动login; 1 - 启用自动login. |
| 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. |
注意对于某些方法(update, delete)所需/可选参数组合有所不同.
媒介
媒体object具有以下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| mediaid | string | (只读) 用户媒体的ID。 |
| userid | string | (只读) 用户的ID。 |
| 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 |