Documentation
用户对象
以下对象都是与 user 相关的API。
用户
用户对象具有如下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| userid | ID | 用户ID。 属性行为: - 只读 - 必填 更新操作时 |
| username | string | 用户名。 属性行为: - 必填 创建操作时 - 只读 对于已设置的用户，若其链接到的用户目录中 userdirectoryid设置为非 “0”的有效值且用户目录对象的provision_status设置为“1”，同时满足LDAP或SAML认证对象中ldap_jit_status或saml_jit_status设置为“1”，则属性只读。 |
| passwd | string | 用户的密码。 如果用户链接到用户目录，则此参数的值可以是空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 | 会话过期时长。 接受带有后缀的秒和时间单位。 如果设置为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 - 黑色主题。 |
| ts_provisioned | timestamp | 最近一次更新配置的时间。 属性行为: - 只读 |
| url | string | 登录后将用户重定向到的URL页面。 |
| userdirectoryid | ID | 用户链接到的用户目录ID。 用于用户配置（创建或更新），以及让链接到用户目录的用户登录。 在执行登录操作时，此属性的值将优先于用户所属用户组 的 “userdirectoryid” 属性。 默认: 0 属性行为: - 只读 |
| timezone | string | 用户的时区，例如, Europe/London, UTC。默认: default - 系统默认时区。有关支持时区的完整列表，请参阅 PHP文档。 |
媒介
媒介对象具有如下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| mediatypeid | ID | 被使用的媒介类型ID。 属性行为: - 必填 |
| sendto | string/array | 用户名或者其他接收标识符。 如果媒介类型是邮件, 值被定义为数组。 如果媒介类型是其他类型, 值被定义为字符串。 属性行为: - 必填 |
| active | integer | 是否启用媒介。 可用值: 0 - (默认) 启用 1 - 禁用 |
| severity | integer | 触发媒介发送告警的告警级别。 每一位数字代表一个告警级别，并以二进制形式存储。 例如, 12 相当于二进制的 1100, 它表示告警级别为警告和一般严重的告警将触发告警媒介。 参阅触发器对象查看告警级别列表。 默认: 63 |
| period | string | 时间窗口: 能够发送告警通知的时间段或者以分号分隔的用户宏。 默认: 1-7,00:00-24:00 |
| userdirectory_mediaid | ID | 预置媒介的用户目录媒介映射ID。 属性行为: - 只读 |