Connect to Directory Service

Last Updated : Aug 30, 2026 |
Navigation: SolutionSolution SettingsUser Synchronization Using LDAPConnect to Directory Service
Prolog information
Metadata
Keywords:
Resource Id: solution101
Use this page to define the connection to the LDAP server and to define the parameters for searching the LDAP directory. All fields are mandatory.

Additional Configuration Information

For additional configuration information, see Managing Users with LDAP.

Configuration Settings

Field
Description
Application
Default = User Synchronization
Select the application type to route to the LDAP server directory details or user details for synchronization. The following types are available:
  • Directory Services
  • User Synchronization
  • User Synchronization & Directory Services
Note:
Selecting the Directory Services or the User Synchronization & Directory Services option allows you to add Number Attributes and Name Attribute.
Host
Default = Blank.
Enter the host name or IP address of the LDAP server.
Port
Default = Blank.
Enter the listening port on the LDAP server. The standard ports used by the LDAP directory are 389 or 90389.
User Name
Default = Blank.
Enter the user name used to log in to the LDAP server.
Password
Default = Blank.
Enter the password for the user account used to log into the LDAP server.
Confirm Password
Default = Blank.
Confirm the user account password.
User Schema
Default = Blank.
Specifies the type of resource in LDAP. For example, the type of user. For IP Office R11.1.2.3 and higher, multiple schemas can be entered as a comma separated list.
Search Filter
Default = Blank.
Specifies which objects under the base are of interest. The search applies to the project name and Location values for each employee.
  • The Search Filter uses the format defined in RFC2254 except that extensible matching is not supported.
  • You must ensure that the whole filter, and each object within the filter, are enclosed within ( ) brackets.
Example search values:
  • Search for all the names starting with A:
    • (name=A*)
  • Get all the phone numbers in a domain, either telephone number or mobile:
    • (|(telephonenumber=*)(mobile=*))
  • Search for a user who is a member of cn=group1, cn=user, dc=acme,dc=com and with a telephone number:
    • (&(memberof=cn=group1,cn=users,dc=acme,dc=com)(telephonenumber=*))
Base Distinguished Name
Default = Blank.
Specifies the point in the LDAP tree to start searching. Specify the hierarchy in reverse order. For example:
  • OU=SBSUsers,OU=Users,OU=MyBusiness,DC=dnsroot,DC=ipoyvr,DC=ca
Number Attributes
Default = Blank.
This setting is available when Directory Services or User Synchronization & Directory Services is selected.
Enter the phone number (home or mobile telephone number) to map with the directory service.
  • telephoneNumber,homePhone=H,mobile=M
Name Attribute
Default = Blank
This setting is available when Directory Services or User Synchronization & Directory Services is selected.
Enter the name to map with the directory service.
Auth Mechanism
Default = Simple
From Simple Authentication and Security Layer (SASL) allows you to select different mechanisms to authenticate the data in the LDAP server. The following mechanisms are supported:
  • CRAM-MD5
  • DIGEST-MD5
Use SSL
Default = No.
When enabled, a secure (SSL) connection must be used to connect to the LDAP server and Security Mechanism is available to provide secure communication by using the TLS protocols.
Security Mechanism
Provides a secure communication by using the TLS protocols.
  • STARTTLS: Used for securing LDAP communication, and uses the default LDAP port (389) to communicate with the LDAP server.
  • LDAPS: Used for securing LDAP communication, and uses the default LDAP port (636) to communicate with the LDAP server.
Add Certificate
Browse to upload the Root CA certificate of the LDAP server that uses .pem format.
Test Connection
When clicked, Web Manager attempts to connect to the LDAP server with the specified credentials.
You must provide the password each time you test the connection.
Save
If the Test Connection action is successful, Save is enabled. Click to save the configuration.
Related links
User Synchronization Using LDAP