Import Users from LDAP

Overview

This guide explains how to import users from your LDAP or Active Directory server into your Drupal site. The module supports Drupal 7, 8, 9, 10, and 11. With the Import Users feature, you can bulk import LDAP users into Drupal and assign roles or permissions easily. You can also enable automatic, periodic user synchronization using Cron. Based on the user’s LDAP status, Drupal accounts can be added, blocked, deleted, or left unchanged.

Download

Pricing Plans

Schedule a Meeting

Installation Steps

Using Composer
Using Drush
Manual Installation

Download the module:
composer require 'drupal/ldap_auth'
Navigate to Extend menu on your Drupal admin console and search for miniOrange Active Directory / LDAP Integration using the search box.
Enable the module by checking the checkbox and click on the Install button.
You can configure the module at:

{BaseURL}/admin/config/people/ldap_auth/ldap_config

Install the module:

drush en ldap_auth
Clear the cache:

drush cr
You can configure the module at:

{BaseURL}/admin/config/people/ldap_auth/ldap_config

Navigate to Extend menu on your Drupal admin console and click on Install new module.
Install the miniOrange Active Directory / LDAP Integration module either by downloading the zip or from the URL of the package (tar/zip).
Click on Enable newly added modules.
Enable this module by checking the checkbox and click on install button.
You can configure the module at:

{BaseURL}/admin/config/people/ldap_auth/ldap_config

Prerequisites

Install the Drupal LDAP / Active Directory Login module.
Setup the above module with your LDAP or Active Directory server. You can also refer to this setup guide for assistance.

You can also follow this setup video to configure the Import Users feature.

Configuration Steps

Once you have successfully configured the module with your LDAP server, navigate to the Provisioning tab of the module and select LDAP server from the Select LDAP Server dropdown.
(admin/config/people/ldap_auth/user_sync)

Expand the Import User from your LDAP Server section.

Drupal LDAP - Expand Import User Section

In the Import users section, you will first find the following options:

Select the frequency of import: Select how often you want to import your LDAP users to your Drupal site. Your LDAP users will be automatically imported based on this selected frequency.
Search User By Email, if not found by Username: Enable this option if you want to search the user by email in Drupal if a user does not found by username. It will prevent the creation of duplicate Drupal accounts.
Enable Attribute and Role Mapping during user sync: You can enable this option if you wish to map the user's attributes and roles coming from the LDAP server based on the mappings saved under the module’s Attribute/Role mapping tab

Drupal LDAP - Enable Search by Email and Attribute/Role Mapping

Auto create users after sync: If, during importing your users in Drupal, you want to automatically create the Drupal account for all LDAP users who are not already present in Drupal, then you can do so by enabling this button. It will provide you with four options. Choose the one that suits your requirements:

When creating a new user account in Drupal, mark it as blocked.
Blocked the user who exists in Drupal but is not found in AD.
Create a new user account in Drupal as per AD. E.g., if a user is blocked in AD, then their corresponding Drupal account will be blocked.
This option does not block any Drupal account.

From the Username Attribute dropdown, select the LDAP attribute that holds the user’s Drupal account username.
Click on the Import Users button to start importing your LDAP users to your Drupal site.