这是原厂英文文档的翻译页面. 欢迎帮助我们 完善文档.
Table of Contents

> 用户对象

以下对象都是与 user 相关的API.

用户

用户对象具有以下属性。

属性 类型 描述
userid string (只读) 用户的ID。
username
(必选)
string 用户名。
roleid
(必选)
string 用户的角色ID。
attempt_clock timestamp (只读) 最后一次不成功的登录尝试的时间。
attempt_failed integer (只读) 最近失败的登录尝试次数。
attempt_ip string (只读) 最后一次不成功的登录尝试来源的IP地址。
autologin integer 是否启用自动登录。

可能的值:
0 - (默认) 自动登录禁用;
1 - 自动登录启用。
autologout string 用户会话生命周期。接受秒数和带有后缀的时间单位。如果设置为0s,则会话永不过期。

默认值:15m。
lang string 用户语言的语言代码,例如,en_GB

默认值:default - 系统默认。
name string 用户的名称。
refresh string 自动刷新周期。接受秒数或带有后缀的时间单位(例如,30s,90s,1m,1h)。

默认值:30s。
rows_per_page integer 每页显示的对象行数。

默认值:50。
surname string 用户的姓氏。
theme string 用户的主题。

可能的值:
default - (默认) 系统默认;
blue-theme - 蓝色;
dark-theme - 深色。
url string 用户登录后的重定向页面URL。
timezone string 用户时区,例如,Europe/LondonUTC

默认值:default - 系统默认。

有关支持的时区完整列表,请参见 PHP文档
alias
(已弃用)
string 此属性已弃用,请改用 username
用户别名。

请注意,对于一些方法(更新,删除),必选/可选参数组合是不同的。

媒介

媒介对象具有如下属性.

属性 属性类型 描述
mediatypeid
(required)
string 被使用的媒介类型ID.
sendto
(required)
string/array 地址, 用户名或者其他接收标识符.

如果 媒介类型 是邮件, 值被定义为数组. 如果 媒介类型 是其他类型, 值被定义为字符串.
active integer 是否启用媒介.

可用值:
0 - (default) 启用;
1 - 禁用.
severity integer 触发媒介发送告警的告警级别.

每一位数字代表一个告警级别,并以二进制形式存储. 例如, 12 相当于二进制的 1100, 它表示告警级别为警告和一般严重的告警将触发告警媒介.

参阅 触发器对象 查看告警级别列表.

默认: 63
period string 时间窗口: 能够发送告警通知的 时间段 或者以分号分隔的用户宏.

默认: 1-7,00:00-24:00