Skip to main content

Connect Active Directory

Workspace scope

This guide covers Active Directory setup through the Authentication > User Stores flow in Workforce workspaces. For the Authentication > Providers flow used in B2B, enterprise, and partner workspaces, see Set up Active Directory for authentication.

Connect your existing Active Directory (AD) to SecureAuth Connect to enable secure authentication for your workforce. This integration uses the SecureAuth LDAP Agent to create a secure connection between SecureAuth and your on-premises AD.

Prerequisites

Before you begin, confirm the following:

  • AD administrative credentials and a service account with read access to AD.
  • AD user accounts have userPrincipalName, first_name, and last_name populated. Accounts missing these attributes do not sync.
  • Network connectivity between the planned LDAP Agent location and your domain controllers.
  • A virtual server or machine to host the LDAP Agent (or an existing LDAP Agent ready to deploy). You can configure the agent host after creating the AD connection. For the deployment process, see the LDAP Agent deployment guide.
  • You have administrative access to the Workforce workspace where you want to add AD as a user store.

Connect Active Directory

Step 1: Create new directory

  1. In your Workforce workspace, go to Authentication > User Stores.

  2. Click Create New Directory.

    Result: The New User Directory page opens.

  3. Select Microsoft Active Directory.

    New User Directory page showing Microsoft Active Directory option highlighted

  4. Click Next.

Step 2: Configure connection details

Complete the basic connection settings.

SettingDescription
NameDescriptive and unique name for the connection. Example: Corporate Active Directory.
DomainsSelect one or more domains from the list. Example: company.com, hr.company.com.
Inline Factor ProvisioningPrompts users to set up authentication factors (like SMS, email, mobile authentication apps) during the login process.
Inline User ProvisioningCreates users automatically upon successful authentication.
Search Directory for GroupsSearch and retrieve group information from directory services.

Active Directory connection details form with Name, Domains, and provisioning options

Step 3: Configure search and password settings

Expand Search Lookup and Password Permission to configure user and group attributes.

SettingDescription
User Identifier AttributeUser identifier from the directory. Make sure the value is unique for each user. Default: mail. Alternatives: sAMAccountName, userPrincipalName.
Group Identifier AttributeDirectory attribute used to find groups and match users. Default: Object GUID. Alternative: distinguishedName.
Nested Group SearchingMatch users to groups through nested (indirect) membership. If a user is in Group A and Group A is a member of Group B, the user matches Group B.
Enable Change PasswordAllow users to change their AD password by entering their current password and a new one. Requires an LDAP Agent version with password change support.
Enable Reset PasswordAllow users to reset their AD password through a password reset flow. Requires an LDAP Agent version with password reset support and bind credentials configured.

Search Lookup and Password Permission settings showing user and group identifier attributes

Step 4: Configure connection settings

Expand Connection Settings to configure agent communication.

SettingDescription
Agent heartbeat timeoutInterval between heartbeat requests to LDAP Agents, in seconds. Default: 35.
Agent CacheCache agent service responses temporarily to maintain functionality during network failures.
Agent Cache Duration(When Agent Cache is enabled.) How long cached agent service responses remain valid. Enter values in hours and minutes. Default: 25 hours (supports daily user logins).
Circuit breakerPrevent the application from sending requests to the target service for a period when the service is unavailable.
Volume Threshold(When Circuit breaker is enabled.) Minimum transaction volume in a time window before the error rate is calculated. Minimum: 0. Default: 10.
Error Threshold(When Circuit breaker is enabled.) Error rate percentage of the transaction volume that triggers the circuit to open. Minimum: 0. Default: 50.
Time Window(When Circuit breaker is enabled.) Time window in seconds over which the error rate is calculated. Minimum: 0. Default: 30.
Sleep Window(When Circuit breaker is enabled.) Time the application waits, in seconds, before sending new requests to the target service after the error threshold is met. Default: 300.

Connection Settings panel showing agent heartbeat timeout and performance options

Step 5: Complete setup

  1. Click Save.
  2. Scroll down the page and download the LDAP Agent binary from the provided link.
  3. Follow the LDAP Agent deployment guide to complete the installation.

Verify Active Directory connection

After configuration, confirm the Directory Information panel shows the directory as online and check the Directory Details.

Active Directory status in the User Directories list Active Directory status in the User Directories list

Active Directory status in edit mode Active Directory status in edit mode

Log locations

  • Windows: C:\Program Files\SecureAuth\LDAP Agent\logs
  • Linux: /var/log/secureauth-ldap-agent

Default directory behavior

When you have multiple user directories (Active Directory, Microsoft Entra ID, identity pools, etc.), SecureAuth uses domain matching to determine which directory to authenticate users against:

  • Domain matching — When a user signs in (for example, jsmith@acme.com), SecureAuth looks for a directory that matches the domain part after @ (like acme.com).

  • Default fallback — If no matching domain is found, SecureAuth uses the directory marked as default.

    User Directories page showing default directory and Set as default button

Set a directory as default

To change which directory serves as the default:

  1. In your Workforce workspace, go to Authentication > User Stores.
  2. Find the directory you want to set as default.
  3. Click Set as default.

Important considerations:

  • Only one directory can be marked as default at a time.
  • Users created directly in the workspace with the same domain name as your AD will not be found if domain matching takes precedence.
  • The default directory is used when no domain match is found during authentication.

See also