Enterprise LDAP Server Configuration field descriptions

Last Updated : Jun 10, 2026 |

Name

Description

Enterprise-Directory Type

Specifies the name of the enterprise directory.

The options are:

  • ActiveDirectory_2012

  • ActiveDirectory_2016

  • ActiveDirectory_2019

  • ActiveDirectory_2022

  • ActiveDirectory_2025

  • Azure Active Directory

  • Domino 7.0 or 8.5.3

  • LDS_2012

  • Novell 8.8

  • OpenLDAP 2.4.44 and 2.4.46

  • OracleDirectoryServer 11.1.1

Provenance Priority

Specifies the provenance priority of the enterprise directory.

Provenance priority is used while merging contacts. If a value is available in more than one directory, the directory value with higher provenance priority is returned. For example, if firstName is obtained from two directories, the firstName from the source with higher provenance priority is returned.

You can assign a value between 2 to 10. You cannot assign Provenance priority 1 because it is always assigned to the authorization directory. Provenance priority 1 is the highest, and 10 is the lowest. Provenance priority must be different for each enterprise directory or source.

Server Address and Credentials

Name

Description

Use for authentication

Specifies whether the server is used for authentication and authorization.

If OAuth is enabled, you can select or clear this check box after installation. If OAuth is enabled, but this check box is not selected, then you can only log in to the Avaya Aura® Device Services web administration portal using the credentials of the administrative user created during OVA installation.

Use for Contact Search

Specifies whether this LDAP server is used for the contact search.

If you use the onboard OpenLDAP server, this option is enabled by default.

Use DNS

Specifies whether Avaya Aura® Device Services uses DNS SRV records to discover the LDAP server.

  • If the check box is selected, Avaya Aura® Device Services uses the domain name specified in the Address field to discover all LDAP servers associated with this domain name in DNS SRV records.

  • If the check box is not selected, Avaya Aura® Device Services uses the IP address or FQDN specified in the Address field to discover the LDAP server.

Secure LDAP

Indicates whether the LDAP server connection is secure or not.

If FIPS is enabled, you must use the secure LDAP connection to access LDAP servers.

If you are using a secure LDAP connection, you must also import the LDAP server trusted certificate to Avaya Aura® Device Services.

Import Certificate

Specifies the LDAP server trusted certificate.

This field is mandatory if you are using a secure LDAP server connection. This field is only displayed when the Secure LDAP check box is selected.

You cannot import a certificate if:

  • The certificate contains an unsupported critical extension.

  • The certificate expired.

  • The start date of the certificate is in the future.

Windows Authentication

Specifies whether to use Windows Authentication.

The options are:

  • None

  • Negotiate

If you select the Negotiate option, the system displays the Configuration for Windows Authentication section.

Note:

Windows authentication is only supported if you are using a single authentication directory. If you are using multiple authentication directories, Windows Authentication is disabled.

Address

Specifies the address of the LDAP server. The exact value depends on the value of the Use DNS field as follows:

  • If the Use DNS check box is not selected, provide the IP address or FQDN of the LDAP server.

    If you use the secure LDAP connection (LDAPS), you must use the LDAP server FQDN. IP addresses are not supported.

    If the LDAP server uses IPv6, use the LDAP server FQDN.

  • If the Use DNS check box is selected, provide a domain name. Avaya Aura® Device Services uses this domain name to discover all LDAP server instances associated with this domain name in DNS SRV records. If multiple LDAP server instances are discovered, Avaya Aura® Device Services determines a LDAP server to connect to based on the priority and weigh settings configured in SRV records.

    Use the following format:

    _<SERVICE>._tcp.<DOMAIN_NAME>.

    In this entry, <SERVICE> is ldap if you use the standard LDAP connection, or ldaps if you use the secure LDAP connection.

    For example: _ldap._tcp.example.com.

    If you use this option, you must also ensure that:

    • The /etc/resolv.conf file contains the specified domain name in the search or domain entry.

    • All DNS servers listed in the /etc/resolv.conf for the domain name contain SRV records for all appropriate LDAP server instances.

This field is mandatory.

Port

Specifies the port of the LDAP server.

Important:

With the global catalog ports 3268 or 3269, LDAP queries can only return attributes marked for replication to the global catalog. For example, a user's department cannot be returned because this attribute is not replicated to the global catalog. You must manually add all required attributes in the global catalog attributes list.

This field is mandatory.

Bind DN

Specifies the Distinguished Name (DN) of the user that has read and search permissions for the LDAP server users and roles. This is a mandatory setting.

The format of the Bind DN depends on the configuration of the LDAP server.

This field is mandatory.

Note:

Even though the parameter name is Bind DN, the format of its value is not limited to the DN format. The format can be any format that the LDAP server can support for LDAP bind.

For example: for Active Directory, you can use domain\user, user@domain, as well as the actual DN of the user object.

Bind Credential

Specifies the password of the administrative user.

The maximum password length depends on the LDAP server type that you use in your deployment.

The supported characters are:

  • Lowercase letters: a to z

  • Uppercase letters: A to Z

  • Numerics: 0 to 9

  • Special characters are supported

Base Context DN

Specifies the complete Distinguished Name (DN) with the Organizational Unit (OU) for starting the search for users on the enterprise directory. This is the primary Base Context DN for Avaya Aura® Device Services. For example, dc=domain, dc=company, dc=com.

If you are using multiple authorization domains, Avaya recommends including a domain component to the Base Context DN. For example, dc=avaya, dc=com.

Note:

Some LDAP sources, such as Domino, typically do not contain the domain component in Base Context DNs. For example, o=MyCompany. If Base Context DNs do not contain the domain component, Avaya Aura® Device Services considers them empty Base Context DNs when processing user login or search requests. If Avaya Aura® Device Services cannot find the domain specified in the request, the search continues in empty Base Context DNs.

Use additional Base Context DN

Enables Avaya Aura® Device Services contact search and quick search. The primary Base Context DN is used for authentication. Additional Base Context DNs are used for Avaya Aura® Device Services contact search and quick search, and can also be used for authentication.

You can configure up to 10 additional Base Context DNs.

If you select this check box, you can see the View/Edit button.

Auto-configuration will use only the primary base context DN.

View/Edit

Enables access to the Addition Base DN Configuration page, where you can add or delete additional Base Context DNs.

UID Attribute ID

Specifies the unique attribute of the user on LDAP, which is used to search for users in the LDAP server.

If you are using multiple authentication domains, you must use one of the following values:

  • mail

  • userPrincipalName

  • Any custom attribute that uses a domain-qualified value

If you are not using multiple authentication domains, you must use one of the following values:

  • uid, if you use OpenLDAP

  • sAMAccountName

  • mail

  • userPrincipalName

This field is mandatory.

Note:

When the UID attribute is set to mail on OpenLDAP, use Apache Directory Studio to set the email value for the OpenLDAP administrative user. This enables the administrative user to log in to the Avaya Aura® Device Services web administration portal using their email.

Role Filter

Specifies the search filter used to search the role of the user.

For example, (&(objectClass=group) (member={1})

Role Attribute ID

Specifies that the user is a member of the groups defined by that attribute.

For example, objectCategory

This field is mandatory.

Roles Context DN

Specifies the complete Distinguished Name (DN) to search for a user role, that is, for Role Filter.

For example, dc=domain,dc=company,dc=com

Role Name Attribute

Specifies the name of the role attribute.

This field is mandatory only if the Role Name Attribute Is DN field is set to true.

For example, cn if the role is stored in a DN in the form of cn=admin, ou=Users, dc=company, dc=com.

Role Attribute is DN

Indicates whether the role attribute of the user contains DN.

The default value is true.

Allow Empty Passwords

Indicates whether LDAP Server acknowledges the empty password.

The default value is false.

Search Scope

Specifies the search level in the LDAP hierarchy.

The options are:

  • Object: For searching only for the object.

  • One Level: For including one level in the LDAP hierarchy in the search.

  • Subtree: For including subtree in the LDAP hierarchy in the search.

The default value is Subtree.

Role Recursion

Specifies whether role recursion is enabled. The options are:

  • true

  • false

If your LDAP configuration includes nested groups, you can set the Role Recursion parameter to true so that Avaya Aura® Device Services computes role membership by searching through LDAP structures recursively.

For example, the user jsmith can be in the Sales group, which can be in the AADS users group. In this case, Role Recursion must be set to true for jsmith to be recognized as a member of the AADS users group.

If you set this parameter to false, Avaya Aura® Device Services does not compute the role membership information recursively.

Note:

Certified with 300 nested groups with 2 levels for each user.

Administrator Role

Specifies the administrator role in which the administrative users are assigned.

Security Administrator Role

Specifies the security administrator role in which the administrative users can manage web certificates from the web administration portal.

User Role

Specifies the user role in which the common users are assigned.

Auditor Role

Specifies the auditor role in which the users can audit the system.

Services Maintenance and Support Role

Specifies the services maintenance and support role in which users can maintain and support services.

Services Administrator Role

Specifies the services administrator role.

Language used in Directory

  • Simplified Chinese (zh)

  • German (de)

  • English (en)

  • Spanish (es)

  • French (fr)

  • Italian (it)

  • Japanese (ja)

  • Korean (ko)

  • Russian (ru)

  • Portuguese (pt)

Active Users Search Filter

Specifies whether the user is active or inactive on LDAP Server.

Users Search Additional Filter

The search filter that provides extended search options in addition to Active users search filter. If you want to search for users using additional criteria other than whether a user is active, provide those criteria in this field.

For example, if you want to search for users in the object class user and the object category Person, use the following filter: (&(objectClass=user)(objectCategory=Person)).

Last Updated Time Attribute ID

Specifies when the user is updated on LDAP. The exact value depends on the LDAP server type that you use. Avaya recommends that you use the following values:

  • For Active Directory: whenChanged.

  • For OpenLDAP: modifyTimestamp.

This field is mandatory.

Configuration for Windows Authentication

Name

Description

Service Principal Name (SPN)

Specifies the service principal name

UIDAttributeID must be userPrincipalName.

Import keytab file

Imports the tomcat.keytab file and overwrites the existing file.

Kerberos Realm

Specifies the Kerberos realm.

DNS Domain

Specifies the DNS domain of the Domain Controller.

KDC FQDN

Specifies the FQDN of the Domain Controller.

KDC Port

Specifies the port number. The default KDC port is 88.

Button

Description

Test Connection

Tests the connection changes.

Save

Saves the changes made to the enterprise directory.

Modify Attribute Mappings

Modifies the attributes of the LDAP server.