Configuring LDAP settings

Last Updated : Jun 27, 2025 |

About this task

Configure LDAP settings to connect to an external database, specify the name and password for authentication, and set search parameters. You can also select the LDAP protocol version and specify the base Distinguished Name (DN). At the bottom of the LDAP page, you can view the LDAP link connection status for the saved LDAP configuration.

With the LDAP Directory feature enabled, users can search for contacts in an external database instead of using locally saved contacts. The LDAP search is available only on the codec GUI menu.

When configuring LDAP settings, you can set up the LDAP filter to limit the scope of data retrieved from the LDAP server. The LDAP server searches the directory entries and displays the results based on the listed criteria. For example, to search for users by their common name, surname, and phone number, you can type cn,sn,telephoneNumber.

You can use the following common LDAP filter types:

  • (attribute=value): for exact matching

  • (attribute=*value*): for wildcard matching

  • (&(cond1)(cond2)): for conditions with the AND operator

  • (|(cond1)(cond2)): for conditions with the OR operator

Procedure

  1. On the Settings menu, go to Network > LDAP.
  2. On the LDAP page, to enable and configure LDAP, enable the LDAP Enable switch.
  3. For the LDAP Type setting, select one of the following LDAP protocol versions:

    • LDAP: To use an insecure protocol version. Avaya recommends using the insecure protocol version only for troubleshooting purposes.

    • LDAPS: To use a secure protocol version. You can use this version for all purposes other than troubleshooting.

    The LDAP protocol type setting is related to the LDAP port setting. If you change the protocol type, you must also update the LDAP port number.

  4. In the LDAP Address field, type the IP address or FQDN of the LDAP directory server.

    You cannot use the ldap://<IP address or FQDN> or ldaps:// entry format.

  5. In the LDAP Port field, type the directory server port number.

    The default port number for the LDAP protocol is 389. The default port number for the LDAPS protocol is 636.

  6. In the LDAP User field, type the name of the user that can access the LDAP directory entries.

    For example, you can type cn=admin,dc=example,dc=com.

  7. In the LDAP Password field, type the password for binding to the LDAP server.

    The password must match the LDAP password for the user that you specified in step 6.

  8. In the LDAP Base DN field, type the base Distinguished Name (DN) from where the LDAP server searches for users.

    For example, if you want to start the search from an organizational unit "people" created in the "example.com" enterprise, you can type the following: ou=people,dc=example,dc=com.

  9. Skip the LDAP Root DN field as this setting is not currently supported.
  10. In the LDAP Filter field, type the criteria for the LDAP filter.

    The filter criteria you can type correspond to the attributes set on the connected LDAP server.

  11. Click Save.