本页内容

用户对象

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

用户

用户对象具有以下属性。

Property Type Description
userid ID 用户的 ID。

属性行为：
- 只读
- 更新操作时必需
username string 用户的名称。

属性行为：
- 创建操作时必需
- 对于已配置用户，如果用户已链接到用户目录（userdirectoryid 已设置为非 "0" 的有效值），且用户目录配置状态已启用（用户目录对象的 provision_status 设置为 "1"），并且所有 LDAP 或 SAML 配置的身份验证状态已启用（身份验证对象的 ldap_jit_status 设置为 "Enabled for configured LDAP IdPs"，或身份验证对象的 saml_jit_status 设置为 "Enabled for configured SAML IdPs"），则为只读
passwd string 用户的密码。

如果用户已链接到用户目录，则此参数的值可以为空字符串。

属性行为：
- 只写
roleid ID 用户角色的 ID。

请注意，没有角色的用户只能使用 LDAP 或 SAML 身份验证登录 Zabbix，前提是其 LDAP/SAML 信息与 Zabbix 中配置的用户组映射相匹配。
attempt_clock timestamp 上次登录失败尝试的时间。

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

属性行为：
- 只读
attempt_ip string 上次登录失败尝试的来源 IP 地址。

属性行为：
- 只读
autologin integer 是否启用自动登录。

可能的值：
0 - （默认）禁用自动登录；
1 - 启用自动登录。
autologout string 用户会话生命周期。接受秒数（例如 1、60、300），或带有时间后缀的值（例如 30s、1m、2h）。如果设置为 0s，会话将永不过期。

默认值：15m。
default_maintenance_period string 通过快捷方式创建的维护的默认维护周期。接受秒数或带后缀的时间单位（300s、5m、1h、1d、1w）。给定值将向下取整为整分钟数。

默认值：1h。
lang string 用户语言的语言代码，例如 en_US。

默认值：default - 系统默认值。
name string 用户的姓名。
provisioned integer 用户是否已配置。

可能的值：
0 - 未配置；
1 - 已配置。

属性行为：
- 只读
refresh string 自动刷新周期。接受秒数（例如 1、60、300），或带有时间后缀的值（例如 30s、1m、1h）。

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

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

可能的值：
default - （默认）系统默认值；
blue-theme - 蓝色；
blue-classic-theme - 蓝色（经典）；
dark-theme - 深色；
dark-blue-theme - 深蓝色；
dark-classic-theme - 深色（经典）；
hc-light - 高对比度浅色；
hc-dark - 高对比度深色。
ts_provisioned timestamp 最近一次配置操作的时间。

属性行为：
- 只读
- 对于 Super admin 类型的用户支持
url string 用户登录后重定向到的页面 URL。
userdirectoryid ID 用户所链接到的用户目录的 ID。

用于配置（创建或更新），以及登录链接到用户目录的用户。

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

默认值：0。

属性行为：
- 只读
- 对于 Super admin 类型的用户支持
timezone string 用户的时区，例如 Europe/London、UTC。

默认值：default - 系统默认值。

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

媒体

媒体对象具有以下属性。

Property Type Description
mediaid ID 用户媒体的 ID。

属性行为：
- 只读
mediatypeid ID 用户媒体所使用的媒体类型的 ID。

属性行为：
- 必需
sendto string/array 接收者的地址、用户名或其他标识符。

如果媒体类型的 type 设置为 "Email" 或 "Push"，则值表示为数组。对于 "Push"，数组可以包含通配符 (*)，或一个或多个移动设备 ID。

如果媒体类型的 type 设置为 "Script"、"SMS" 或 "Webhook"，则值表示为字符串。

属性行为：
- 必需
active integer 媒体是否已启用。

可能的值：
0 - (默认) 已启用；
1 - 已禁用。
severity integer 需要发送通知的触发器严重性。

可能的位图值：
1 - 未分类；
2 - 信息；
4 - 警告；
8 - 一般；
16 - 严重；
32 - 灾难。

这是一个位掩码字段；可以使用任意可能位图值的总和（例如，48 表示一般、严重和灾难）。

默认值：63。
period string 可以发送通知的时间，格式为时间段或以分号分隔的用户宏。

默认值：1-7,00:00-24:00。
provisioned integer 用户是否已配置。

可能的值：
0 - 未配置；
1 - 已配置。
userdirectory_mediaid ID 已配置媒体的用户目录媒体映射 ID。

属性行为：
- 只读
- 超级管理员类型用户支持