--- title: "LDAP" slug: "ldap" status: "new" updated: 2026-11-17T17:34:27Z published: 2026-11-17T17:34:27Z canonical: "help.symphonysummitai.com/ldap" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt > Use this file to discover all available pages before exploring further. # LDAP LDAP / Active Directory credentials enable Discovery to connect to an LDAP server or Active Directory domain and retrieve information about computers, users, groups, and organizational units. Use a service account with read access to the target domain. The default permissions assigned to a domain user are enough for reading directory information. Use LDAPS for encrypted connections in production environments. ### Configure an LDAP Credential Profile Create an LDAP credential profile to allow Discovery to connect to an LDAP server or Active Directory domain and retrieve directory information. Perform the following steps to configure an LDAP credential profile: 1. Select the **LDAP / AD** credential category. 2. Select the **LDAP** tab. 3. Select **New account**. 4. Select the required Department. 5. Enter a profile name. 6. Enter the fully qualified domain name or IP address of the LDAP server or domain controller in **LDAP Server / DC**. 7. Enter the connection port in **Port**: - Enter 389 for a standard LDAP connection. - Enter 636 for an LDAPS connection. 8. Enter the distinguished name of the service account in **Bind DN**. 9. Enter the service account password in **Bind Password**. 10. Enter the directory search base in **Base DN**. Leave this field blank to detect the base DN automatically from RootDSE. 11. Enable **Use LDAPS (port 636, encrypted)** when you want to use an encrypted connection. 12. Enter the target host name or IP address in **Test target host / IP**. 13. Select the Discovery Worker that must perform the connection test from **Discovery worker**. 14. Select **Test Connection** to check the LDAP server details, service account credentials, and connectivity. 15. After a successful connection test, select **Save Profile**. Select **Cancel** to discard the entered information. ### LDAP Credential Fields | Field Name | Description | | --- | --- | | Department | Select the Department for which you want to create the LDAP credential profile. | | Profile Name | Enter a unique and descriptive name for the credential profile. For example, Production Active Directory. | | LDAP Server / DC | Enter the fully qualified domain name or IP address of the LDAP server or domain controller. For example, dc01.example.com or 192.168.102.50. | | Port | Enter the port used to connect to the LDAP server or domain controller. The standard LDAP port is 389, and the standard LDAPS port is 636. | | Bind DN | Enter the distinguished name of the service account used to authenticate with LDAP or Active Directory. For example, CN=user,OU=Service Accounts,DC=example,DC=com. Do not enter the account in the DOMAIN\user format. For more information, refer Bind DN | | Bind Password | Enter the password associated with the service account specified in **Bind DN**. | | Base DN | Enter the distinguished name that defines the starting point for directory searches. For example, OU=Servers,DC=example,DC=com. Leave this field blank to detect the base DN automatically from RootDSE. For more information, refer [Base DN](/apex/docs/ldap#base-dn-configuration) | | Use LDAPS (port 636, encrypted) | Enable this option to encrypt the connection through LDAPS. When enabled, use port 636 unless the target environment uses a custom LDAPS port. | | Test target host / IP | Enter the host name or IP address against which you want to test the credential profile. For example, 10.0.0.12 or dc01.example.com. | | Discovery worker | Select the Discovery Worker that must perform the connection test. The connection test uses the selected worker to connect to the target LDAP server or domain controller. | ### LDAP and LDAPS Connection Options | Connection Type | Default Port | Description | | --- | --- | --- | | LDAP | 389 | Connects to the LDAP server or domain controller through a standard LDAP connection. | | LDAPS | 636 | Connects to the LDAP server or domain controller through an encrypted TLS connection. Enable **Use LDAPS (port 636, encrypted)** to use this connection type. | **Important:** Use LDAPS in production environments to protect the service account credentials and directory information during transmission. ### Bind DN Format The **Bind DN** field requires the complete distinguished name of the LDAP or Active Directory service account. Use the following format: `CN=<account-name>,OU=<organizational-unit>,DC=<domain-component>,DC=<domain-component>` For example: `CN=svc-discovery,OU=Service Accounts,DC=example,DC=com` Do not enter the account in the format: *DOMAIN\user* ### Base DN Configuration The **Base DN** determines the starting point for LDAP or Active Directory searches. | Configuration | Result | | --- | --- | | Blank Base DN | Detects the base DN automatically from RootDSE and searches the accessible directory structure. | | Domain Base DN | Searches from the specified domain root. For example, DC=example,DC=com. | | Organizational Unit Base DN | Limits the search to the specified organizational unit and its child objects. For example, OU=Servers,DC=example,DC=com. | ## Manage LDAP Credential Profiles The credential profile list displays the configured LDAP / Active Directory credential profiles. - [Credential Profile List](/apex/docs/ldap#credential-profile-list) - [Activate or Deactivate an LDAP Credential Profile](/apex/docs/ldap#activate-or-deactivate-an-ldap-credential-profile) - [Edit an LDAP Credential Profile](/apex/docs/ldap#edit-an-ldap-credential-profile) - [View LDAP Credential Profile History](/apex/docs/ldap#view-ldap-credential-profile-history) - [Change History Fields](/apex/docs/ldap#change-history-fields) - [List Page Actions](/apex/docs/ldap#list-page-actions) ### Credential Profile List | Column | Description | | --- | --- | | Account Name | Displays the name assigned to the LDAP credential profile. | | Type | Displays **LDAP** as the credential type. | | Username | Displays the account name associated with the LDAP credential profile. | | Active Status | Indicates whether the credential profile is active. Use the toggle to activate or deactivate the profile. | | Last Updated | Displays the date and time when a user last updated the credential profile. Select the column heading to sort the profiles by the last updated date and time. | | Actions | Provides options to edit the credential profile or view its change history. | ### Activate or Deactivate an LDAP Credential Profile Use the **Active Status** toggle to control whether Discovery can use the LDAP credential profile. - Turn on the toggle to activate the credential profile. - Turn off the toggle to deactivate the credential profile. A deactivated credential profile remains available in the list, but Discovery does not use the profile for future discovery operations. ### Edit an LDAP Credential Profile To edit an LDAP credential profile: 1. Select the **LDAP / AD** credential category. 2. Select the **LDAP** tab. 3. Locate the credential profile in the list. 4. Select the **Edit** icon under **Actions**. 5. Update the required profile details. 6. Enter or update the bind password when required. 7. Enter a host name or IP address in **Test target host / IP**. 8. Select the Discovery Worker that must perform the connection test. 9. Select **Test Connection** to test the updated credentials and connectivity. 10. Select **Save Profile**. ### View LDAP Credential Profile History The credential profile history provides a read-only record of changes made to the selected LDAP credential profile. The newest changes display first, and secret values remain masked. To view the credential profile history: 1. Select the **LDAP / AD** credential category. 2. Select the **LDAP** tab. 3. Locate the credential profile in the list. 4. Select the **History** icon under **Actions**. 5. Review the available change records. #### Change History Fields | Field Name | Description | | --- | --- | | Field name | Displays the name of the LDAP credential profile field added or modified, such as **Discovery Credential Name**, **Department**, **Used for**, or **Active**. | | Old value | Displays the field value before the change. A hyphen (—) displays when no previous value exists. Secret values remain masked. | | New value | Displays the field value after the change. Secret values remain masked. | | Date changed | Displays the date and time when the change occurred. | | Changed by | Displays the identifier of the user who made the change. | The page also displays the number of available change records. **End of history** indicates that no other records are available. Select **Close** to close the **Change history** page and return to the LDAP credential profile list. ### List Page Actions | Action | Description | | --- | --- | | New account | Opens the form for creating an LDAP credential profile. | | Active Status | Activates or deactivates the LDAP credential profile. | | Edit | Opens the selected LDAP credential profile for modification. | | History | Displays the change history for the selected LDAP credential profile. |