Skip to main content

Active Directory (AD) Integration User Manual

1. Overview​

Feature Name​

Active Directory (AD) Integration

Purpose​

The Active Directory Integration plugin enables centralized user authentication and user management by connecting the system to a Microsoft Active Directory (AD) or LDAP server.

After successful integration, administrators can:

  • Authenticate users using their AD credentials
  • Synchronize user accounts from Active Directory
  • Automatically create new users in the system
  • Update existing user information when changes occur in AD
  • Perform manual user synchronization whenever required

2. Prerequisites

Before configuring the plugin, ensure the following information is available:

ParameterDescription
LDAP Server URLAD/LDAP server address
AD DomainActive Directory domain name
Base DNLDAP search base
LDAP AccountService account used for LDAP connection
LDAP PasswordPassword of the service account

Example Configuration​

FieldExample
LDAP Server URLldap://ad.example.com:389
AD Domainexample.com
Base DNDC=example,DC=com
LDAP Accountldapadmin
LDAP Password********

3. Configuring LDAP Authentication

Navigate to:

Configuration → Plugins → LDAP Authentication

The LDAP Authentication configuration screen will be displayed.

LDAP Configuration Fields​

LDAP Server URL​

Enter the LDAP server endpoint.

Examples:

ldap://ad.example.com:389

or

ldaps://ad.example.com:636

AD Domain​

Specify the Active Directory domain name.

Example:

example.com

Base DN​

Specify the Base Distinguished Name used to search users.

Example:

DC=example,DC=com

LDAP Account​

Enter the LDAP bind account username.

Example:

ldapadmin

LDAP Password​

Enter the password for the LDAP bind account.

Example:

********

Enable LDAP Authentication​

  1. Enable the LDAP Authentication toggle.
  2. Enter all required LDAP configuration details.
  3. Click Save Configuration.

The system validates the connection with the Active Directory server.

4. AD Authentication Process

After successful configuration:

  1. User enters username and password on the login page.

  2. System sends authentication request to Active Directory.

  3. Active Directory validates the credentials.

  4. If authentication succeeds:

    • User is granted access to the system.

  5. If authentication fails:

    • Login is denied.

5. User Synchronization

Purpose​

User synchronization imports user accounts from Active Directory into the system.

Synchronization can be performed only after successful AD integration.

Data Retrieved from Active Directory​

The system fetches only the following user attributes:

Active Directory FieldSystem Field
UsernameUsername
EmailEmail Address

No additional user attributes are synchronized.

6. User Creation Rules

Create New User​

A new user account is created when:

  • Username does not exist in the system.
  • Email does not exist in the system.

Result​

New user account created automatically.

7. User Update Rules

Update Existing User​

An existing user account is updated when:

  • A matching user is found based on username or email.

And:

  • Username has changed in Active Directory

or

  • Email address has changed in Active Directory

Result​

Existing user information is updated with latest Active Directory values.

8. Synchronization Modes

Manual Synchronization​

Administrators can manually trigger synchronization at any time.

Steps​

  1. Navigate to:
Configuration → Plugins → LDAP Authentication
  1. Click Sync Users.
  2. System connects to Active Directory.
  3. User records are imported and updated according to synchronization rules.
  4. Synchronization summary is displayed.

Example Summary​

Users Found: 150
New Users Created: 12
Users Updated: 8
Failed Records: 0

9. Synchronization Workflow

image

10. Expected Outcomes

After successful AD integration:

  • Users can log in using Active Directory credentials.
  • User accounts can be synchronized from Active Directory.
  • New users are automatically created during but manually need to synchronize.
  • Existing users are updated when Active Directory information changes.
  • Username and Email are synchronized from Active Directory.
  • Administrators can manually trigger synchronization whenever required.
Last updated on