Documentation
用户 object
以下objects直接与userAPI相关。
用户
用户 object 具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| userid | ID | 用户的ID。 属性行为: - 只读 - 必需的 用于 update 操作 |
| username | string | 用户名称。 属性行为: - 对于 create 操作是必填项 - 对于 默认认证 是只读，如果用户链接到一个 user directory（ userdirectoryid 设置为不是 "0" 的有效值），并且用户目录配置状态已启用（用户目录 的 provision_status 设置为 "1"），以及所有 LDAP 或 SAML 配置的身份验证状态已启用（认证 的 ldap_jit_status 设置为“为已配置的 LDAP IdP 启用”或 认证 的 saml_jit_status 设置为“为已配置的 SAML IdP 启用”） |
| passwd | string | 用户的密码。 如果用户链接到 user directory，则此参数的值可以是空的 string。 属性行为： - 仅写入 |
| roleid | ID | 用户角色的ID。 请注意，没有角色的用户只能通过 LDAP 或 SAML 认证方式登录 Zabbix，且其 LDAP/SAML 信息必须与 Zabbix 中配置的用户组映射相匹配。 |
| attempt_clock | timestamp | 上次不成功的 login 尝试的时间。 属性行为: - 只读 |
| attempt_failed | integer | 最近失败的 login 尝试次数。 属性行为： - 只读 |
| attempt_ip | string | 上次失败的 login 尝试所来自的 IP 地址。 属性行为： - 只读 |
| autologin | integer | 是否启用自动登录。 可能的值： 0 - （默认） 禁用自动login； 1 - 启用自动login。 |
| autologout | string | 用户会话生命周期。接受带后缀的秒数和时间单位。如果设置为 0s，会话将永不过期。 默认值：15m。 |
| lang | string | 用户语言的语言代码，例如 en_US。默认值： default - 系统默认值。 |
| name | string | 用户名称。 |
| provisioned | integer | 用户是否已被 provisioned。 可能的值： 0 - 未配置； 1 - 已配置。 自 Zabbix 7.0.9 起支持此属性。 属性行为： - 只读 |
| refresh | string | 自动刷新周期。接受秒数或带后缀的时间单位（例如：30s，90s，1m，1h）。 默认值：30s。 |
| rows_per_page | integer | 每页显示的object行数。 默认值：50。 |
| surname | string | 用户的姓氏。 |
| theme | string | 用户的主题。 可能的取值： default - (默认) 系统默认；blue-theme - 蓝色；dark-theme - 深色。 |
| ts_provisioned | timestamp | 最近一次 provisioning 操作的时间。 属性行为： - 只读 - 支持 Super admin 类型用户（自 Zabbix 7.0.9 起） |
| url | string | 登录后重定向用户的页面 URL。 |
| userdirectoryid | ID | 与用户关联的 user directory 的 ID。 用于供应（创建或更新）以及 login 与用户目录关联的用户。 对于 login 操作，此属性的值将优先于用户所属 用户组 的 userdirectoryid 属性。默认值：0。 属性行为: - 只读 - 支持 Super admin 类型用户（自 Zabbix 7.0.9 起） |
| timezone | string | 用户的时区，例如：Europe/London、UTC。默认值： default - 系统默认时区。支持的时区完整列表请参考 PHP documentation。 |
媒介
媒介 object 具有以下属性。
| 属性 | 类型 | 说明 |
|---|---|---|
| mediaid | ID | 用户媒介的 ID。 属性行为: - 只读 |
| mediatypeid | ID | 用户媒介使用的媒介类型的 ID。 属性行为: - 必填 |
| sendto | string/array | 接收方的地址、用户名或其他标识符。 如果 媒介类型 的 type 设置为 "Email"，则值表示为 array。对于其他类型的 媒介类型，值表示为 string。属性行为: - 必填 |
| active | integer | 媒介是否启用。 可能的值： 0 - (默认) 启用； 1 - 禁用。 |
| severity | integer | 发送通知的触发器严重程度。 可能的位图值： 1 - 未分类； 2 - 信息； 4 - 警告； 8 - 一般严重； 16 - 严重； 32 - 灾难。 这是一个位掩码字段；可以接受任何可能位图值的总和（例如，48 表示一般严重、严重和灾难）。 默认值：63。 |
| period | string | 可以发送通知的时间，表示为 time period 或以分号分隔的用户宏。 默认值：1-7,00:00-24:00。 |
| provisioned | integer | 用户是否已被 provisioned。 可能的值： 0 - 未配置； 1 - 已配置。 此属性自 Zabbix 7.0.9 起支持。 |
| userdirectory_mediaid | ID | 已配置媒介的用户目录媒介映射 ID。 属性行为: - 只读 - 支持 超级管理员类型用户（自 Zabbix 7.0.9 起） |