Skip to main content
Skip table of contents

Directory Connections

IDMS can connect to Active Directory to retrieve users that need to be credentialed. The processes below provide the steps to configure a directory-based connection as well as perform maintenance and deletion functions.


Prerequisites


Configuring a Directory for System Connection

Item

 Procedure

Example 

1

Authenticate to the IDMS as a system administrator. Once logged in, go to the Administration, then the System Connections tab.

image-20260601-154722.png

2

Select + System Connection, then select Directory. A new panel will open to enter the directory details.

image-20260601-154737.png

Create New System Connection

image-20260601-154812.png

Add a New Directory

3

Next, complete the following information:

  • Directory Type: Drop down includes Active Directory, RedHat Enterprise Directory, Web Queue, Express Entry, or SQL Database.

  • Friendly Name: A name that will help describe the directory connection.

  • DNS Name: This is the IP address of DNS of the active directory that contains the organization's users that will be credentialed.

  • Port: This is the port number of the active directory.

  • User Name: This is the user/service that can log into active directory and perform search queries.

  • Password: This is the password of the user/service that will login and perform queries.

  • LDAP Search Path: This is the location of where the users will be searched.

  • LDAP Search Filter: This is the LDAP attribute the IDMS will use to search the directory. For example, if the SN (Last Name) is specified, the IDMS will search the directory by Last Name.

  • LDAP To IDMS Linking Key: Once a user has been entered into the IDMS, the IDMS will search its internal database to locate the user. The LDAP to IDMS Linking key sets the attribute from the directory the IDMS should use to link the identity.

    • For example, if UID is the linking key, the IDMS will locate the user by UID.

  • LDAP Rule Criteria: This value is used when the IDMS needs to retrieve data from the directory for rule validation.

  • LDAP Attribute(s) To Be Validated: This configuration allows the operator to specify additional LDAP Attributes to be retrieved from the directory, which can then be used for further validation or to assist the operator select the correct applicant for processing.

image-20260601-155007.png

Directory Page

Sample LDAP to IDMS Linking Key:

RedHat Directory: UID

ActiveDirectory: samAccountName

image-20260601-155756.png

LDAP Supporting Fields

4

Once the data is entered, press Add. The system will return to the system information screen showing the new directory.

5

Next you can test the connection. From the System Connections screen, press the gear icon next to the directory and select the Test Connection button.

The result will appear in the Health Check field, displaying status, timestamp, and duration.

image-20260601-160126.png


Modifying an Existing Directory

Item

Procedure

Example

1

Once logged in, go to the Administration, then the System Connections tab.

image-20260601-154722.png

2

Go to the System Connections screen, then press the gear icon next to the directory and select the Configure System button.

3

The system parameters can be updated. The User must also enter the password to make changes.

Once the data has been updated, press Update to complete.

image-20260604-144443.png

4

Then you can test the updated connection. From the System Connections screen, press the gear icon next to the directory and select the Test Connection button.

The result will appear in the Health Check field, displaying status, timestamp, and duration.


Deleting an Existing Directory

Item

Procedure

Example

1

Once logged in, go to the Administration, then the System Connections tab.

image-20260601-154722.png

2

Go to the System Connections screen, then press the gear icon next to the directory and select the Configure System button.

3

Once inside the Directory Configure screen, select the Delete System button to remove the directory.

Then press Save.

image-20260604-144843.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.