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

> 用户对象

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

用户

用户对象具有如下属性.

属性 类型 描述
userid 字符串 (只读) 用户ID.
username
(必需)
字符串 用户名称.
attempt_clock 时间戳 (只读) 最近一次登录失败时间.
attempt_failed 整数 (只读) 最近登录失败尝试次数.
attempt_ip 字符串 (只读) 最近一次登录失败的来源IP地址.
autologin 整数 是否允许自动登录.

可用值:
0 - (default) 禁止自动登录;
1 - 允许自动登录.
autologout 字符串 会话过期时长. 接受具有后缀的秒或时间单位. 如果设置为 0s, 会话将永不过期.

默认: 15m.
lang 字符串 用户语言代码, 示例, en_GB.

默认: default - 系统默认语言.
name 字符串 用户名.
refresh 字符串 自动刷新间隔. 接受具有后缀的秒或时间单位.

默认: 30s.
rows_per_page 整数 每页显示的对象条目.

默认: 50.
surname 字符串 姓.
theme 字符串 用户的主题.

可用值:
default - (default) 系统默认主题;
blue-theme - 蓝主题;
dark-theme - 黑主题.
url 字符串 用户登录后重定向页面的URL.
timezone 字符串 用户时区, 示例, Europe/London, UTC.

默认: default - 系统默认时区.

查看所有支持的时区列表请参阅 PHP documentation.
roleid
(required)
字符串 用户的角色ID.

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

媒介

媒介对象具有如下属性.

属性 属性类型 描述
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