Zabbix Summit 2022
Register for Zabbix Summit 2022

> 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.
string Unique name of the user directory.
string LDAP server host name, IP or URI. URI should contain schema, host and port (optional).
integer LDAP server port.
string LDAP base distinguished name string.
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:
start_tls integer LDAP startTLS option. It cannot be used with ldaps:// protocol hosts.

Possible values:
0 - (default) disabled;
1 - enabled.

Filter search_filter supported placeholders:

Value Description
%{attr} Search attribute name (uid, sAMAccountName).
%{user} Username value.