Table of Contents

用户对象

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

用户

用户对象具有以下属性。

属性 类型 描述
userid ID 用户ID。

属性行为:
- 只读
- 更新操作所需
username 字符串 用户的名称。

属性行为:
- 创建操作所需
- 对于已配置用户,如果用户与用户目录关联(userdirectoryid设置为有效值,而非"0"),且用户目录配置状态启用(provision_status用户目录对象设置为"1"),且所有LDAP或SAML配置的认证状态启用(ldap_jit_status认证对象设置为"为配置的LDAP IdPs启用"或saml_jit_status认证对象设置为"为配置的SAML IdPs启用"),则为只读
passwd 字符串 用户的密码。

如果用户与用户目录关联,此参数的值可以为空字符串。

属性行为:
- 写入只读
roleid ID 用户的角色ID。

请注意,没有角色的用户只能使用LDASAML认证登录Zabbix,前提是其LDA/SAML信息与Zabbix中配置的用户组映射匹配。
attempt_clock 时间戳 最后一次不成功登录尝试的时间。

属性行为:
- 只读
attempt_failed 整数 最近失败的登录尝试次数。

属性行为:
- 只读
attempt_ip 字符串 最后一次不成功登录尝试的来源IP地址。

属性行为:
- 只读
autologin 整数 是否启用自动登录。

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

默认:15m。
lang 字符串 用户的语言代码,例如,en_US

默认:default - 系统默认。
name 字符串 用户的名字。
provisioned 整数 用户是否已被配置

可能的值:
0 - 未配置;
1 - 已配置。

此属性自Zabbix 7.0.9版本起支持。

属性行为:
- 只读
refresh 字符串 自动刷新周期。接受秒数或带后缀的时间单位(例如,30s, 90s, 1m, 1h)。

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

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

可能的值:
default - (默认) 系统默认;
blue-theme - 蓝色;
dark-theme - 深色。
ts_provisioned 时间戳 最后一次配置操作的时间。

属性行为:
- 只读
- 支持 超级管理员类型用户(自Zabbix 7.0.9版本起)
url 字符串 登录后用户重定向到的页面的URL。
userdirectoryid ID 用户目录的ID,用户与此目录关联。

用于配置(创建或更新),以及用于登录与用户目录关联的用户。

对于登录操作,此属性的值将优先于用户所属的用户组userdirectoryid属性。

默认:0。

属性行为:
- 只读
- 支持 超级管理员类型用户(自Zabbix 7.0.9版本起)
timezone 字符串 用户的时区,例如,Europe/LondonUTC

默认:default - 系统默认。

有关支持的时区的完整列表,请参阅PHP文档

媒体

媒体对象具有以下属性。

属性 类型 描述
mediatypeid ID 媒体所使用的媒体类型ID。

属性行为:
- 必需
sendto string/数组 收件人的地址、用户名或其他标识符。

如果媒体类型type设置为"Email",值以数组形式表示。对于其他类型的媒体类型,值以字符串形式表示。

属性行为:
- 必需
active 整数 媒体是否启用。

可能的值:
0 - (默认) 启用;
1 - 禁用。
severity 整数 发送通知的触发器严重性。

可能的位图值:
1 - 未分类;
2 - 信息;
4 - 警告;
8 - 平均;
16 - 高;
32 - 灾难。

这是一个位字段;任何可能的位图值之和都是可接受的(例如,48表示平均、高和灾难)。

默认:63。
period 字符串 可以发送通知的时间,表示为时间周期或分号分隔的用户宏。

默认:1-7,00:00-24:00。
provisioned 整数 用户是否已被预置

可能的值:
0 - 未预置;
1 - 已预置。

此属性自Zabbix 7.0.9版本起支持。
userdirectory_mediaid ID 预置媒体的用户目录媒体映射ID。

属性行为:
- 只读
- 支持 超级管理员类型用户(自Zabbix 7.0.9版本起)