Skip to main content
You can make your LDAP server connection settings from this section. The components of the LDAP page are described in the tables below.

​
LDAP Connection Settings

LDAP ProtocolThis field specifies the LDAP protocol to be used. It is typically set to “ldap” (plain text) or “ldaps” (encrypted with SSL/TLS). You can choose based on your security requirements.
LDAP ServerSpecifies the address of the LDAP server. This field contains the IP address or domain name of the LDAP server, e.g., “ldap.example.com.”
LDAP Server PortThis field specifies the port number to be used for connecting to the LDAP server. The standard port for LDAP is usually 389.
Custom PortThis field is used to specify a custom LDAP server address and port number, e.g., “ldap://ldap.example.com:389.”
Base Distinguished Name (Base DN)Base DN specifies the root directory from which LDAP queries will start. It indicates where the queries should begin. For example, you can use a base DN like “dc=example,dc=com.”
User Distinguished Name (User DN)This field contains the username to be used for connecting to the LDAP server. The username is usually specified in the Distinguished Name (DN) format, e.g., “cn=admin, dc=example, dc=com.”
LDAP PasswordContains the password associated with the LDAP username. This is the password required for access to the LDAP server.

​
LDAP Query Settings

The section with settings for communicating with the LDAP server and configuring queries includes settings for accessing the LDAP server, query settings and other related settings.
User Object CategoryThis field specifies the object category in the LDAP server that defines users. When querying users, records matching this object category are searched. For example, the “person” object category typically represents users.
Retrieve Invalid UsersWhen selected, this option determines whether invalid users (e.g., inactive, deleted, or disabled users) are included in query results. In other words, it controls whether inactive or deleted users are visible in the results.
First Name AttributeIn this field, specify the LDAP attribute name to access users’ first names. For example, you can retrieve users’ first names using the “name” LDAP attribute.
Custom PortThis field is used to specify a custom LDAP server address and port number, for instance, “ldap://ldap.example.com:389.”
Last Name AttributeSpecify the LDAP attribute name to access users’ last names. For instance, you can access users’ last names using the “surname” LDAP attribute.
Email AttributeIn this field, provide the LDAP attribute name to access users’ email addresses. For example, you can access users’ email addresses through the “mail” LDAP attribute.
Position AttributeSpecify the LDAP attribute name to access users’ job positions. For example, you can retrieve users’ job positions using the “title” LDAP attribute.
Department AttributeThis field is used to specify the LDAP attribute name for accessing users’ department information. You can access users’ department details through the “department” LDAP attribute.
Include OUs as GroupsThis option is used to include users in groups based on their Organizational Unit (OU) structure. It allows for grouping users based on their organizational units.
Include Departments as GroupsThis option is used to include users in groups based on their departments. It facilitates grouping users based on their respective departments.