Table of Contents
User object
The following objects are directly related to the user API.
User
The user object has the following properties.
| Property | Type | Description |
|---|---|---|
| userid | ID | ID of the user. Property behavior: - read-only - required for update operations |
| username | string | User's name. Property behavior: - required for create operations - read-only for provisioned users if the user is linked to a user directory ( userdirectoryid is set to a valid value that is not "0"), and user directory provisioning status is enabled (provision_status of User directory object is set to "1"), and authentication status of all LDAP or SAML provisioning is enabled (ldap_jit_status of Authentication object is set to "Enabled for configured LDAP IdPs" or saml_jit_status of Authentication object is set to "Enabled for configured SAML IdPs") |
| passwd | string | User's password. The value of this parameter can be an empty string if the user is linked to a user directory. Property behavior: - write-only |
| roleid | ID | ID of the role of the user. Note that users without a role can log into Zabbix only using LDAP or SAML authentication, provided their LDAP/SAML information matches the user group mappings configured in Zabbix. |
| attempt_clock | timestamp | Time of the last unsuccessful login attempt. Property behavior: - read-only |
| attempt_failed | integer | Recent failed login attempt count. Property behavior: - read-only |
| attempt_ip | string | IP address from where the last unsuccessful login attempt came from. Property behavior: - read-only |
| autologin | integer | Whether to enable auto-login. Possible values: 0 - (default) auto-login disabled; 1 - auto-login enabled. |
| autologout | string | User session life time. Accepts seconds and time unit with suffix. If set to 0s, the session will never expire. Default: 15m. |
| lang | string | Language code of the user's language, for example, en_US.Default: default - system default. |
| name | string | Name of the user. |
| refresh | string | Automatic refresh period. Accepts seconds or time unit with suffix (e.g., 30s, 90s, 1m, 1h). Default: 30s. |
| rows_per_page | integer | Amount of object rows to show per page. Default: 50. |
| surname | string | Surname of the user. |
| theme | string | User's theme. Possible values: default - (default) system default;blue-theme - Blue;dark-theme - Dark. |
| ts_provisioned | timestamp | Time when the latest provisioning operation was made. Property behavior: - read-only |
| url | string | URL of the page to redirect the user to after logging in. |
| userdirectoryid | ID | ID of the user directory that the user in linked to. Used for provisioning (creating or updating), as well as to login a user that is linked to a user directory. For login operations the value of this property will have priority over the userdirectoryid property of user groups that the user belongs to.Default: 0. Property behavior: - read-only |
| timezone | string | User's time zone, for example, Europe/London, UTC.Default: default - system default.For the full list of supported time zones please refer to PHP documentation. |
Media
The media object has the following properties.
| Property | Type | Description |
|---|---|---|
| mediatypeid | ID | ID of the media type used by the media. Property behavior: - required |
| sendto | string/array | Address, user name or other identifier of the recipient. If type of Media type is set to "Email", values are represented as array. For other types of Media types, value is represented as a string.Property behavior: - required |
| active | integer | Whether the media is enabled. Possible values: 0 - (default) enabled; 1 - disabled. |
| severity | integer | Trigger severities to send notifications about. Possible bitmap values: 1 - Not classified; 2 - Information; 4 - Warning; 8 - Average; 16 - High; 32 - Disaster. This is a bitmask field; any sum of possible bitmap values is acceptable (for example, 48 for Average, High, and Disaster). Default: 63. |
| period | string | Time when the notifications can be sent as a time period or user macros separated by a semicolon. Default: 1-7,00:00-24:00. |
| userdirectory_mediaid | ID | User directory media mapping ID for provisioned media. Property behavior: - read-only |