Table of Contents
> User directory object
The following objects are directly related to the userdirectory API.
User directory
The user directory object has the following properties.
| Property | Type | Description |
|---|---|---|
| userdirectoryid | string | (readonly) ID of the user directory. |
| name (required) |
string | Unique name of the user directory. |
| host (required) |
string | LDAP server host name, IP or URI. URI should contain schema, host and port (optional). |
| port (required) |
integer | LDAP server port. |
| base_dn (required) |
string | LDAP base distinguished name string. |
| search_attribute (required) |
string | LDAP attribute name to identify user by username in Zabbix database. |
| bind_dn | string | LDAP bind distinguished name string. Can be empty for anonymous binding. |
| bind_password | string | LDAP bind password. Can be empty for anonymous binding. Available only for userdirectory.update and userdirectory.create requests. |
| description | string | User directory description. |
| search_filter | string | LDAP custom filter string when authenticating user in LDAP. Default value: (%{attr}=%{user}) |
| start_tls | integer | LDAP startTLS option. It cannot be used with ldaps:// protocol hosts.Possible values: 0 - (default) disabled; 1 - enabled. |
Note that for some methods (update, delete) the required/optional parameter combination is different.
Filter search_filter supported placeholders:
| Value | Description |
|---|---|
| %{attr} | Search attribute name (uid, sAMAccountName). |
| %{user} | Username value. |