Active Directory Application

Last modified by Administrator on 2019/05/19 00:00

Active Directory Application

Authenticate users against an Active Directory server (LDAP). Note that this is a paying application.

Active Installs51
2 Votes
LicenseGNU Lesser General Public License 2.1

Active Directory application represents one of the many User Authentication mechanisms available in XWiki and it uses the information from an Active Directory server.

A connection needs to be set between XWiki and Active Directory in order to synchronize their users and groups. Active Directory users will be able to authenticate in XWiki and a dedicated XWiki user will be created at the first login.

In order to use this application, follow the Installation guide and then configure it from the Wiki Administration

The following image is an overview of the Active Directory application. To find out more about how to use and configure the application please read the Documentation.


Before starting this configuration guide, make sure that you already have an Active Directory server configured.

Connection settings

The Check connection button helps to check in real time that the authentication credentials are correct.


Active Directory server addressThe address of the Active Directory server127.0.0.1
Active Directory server portThe port of the Active Directory server389
Active Directory server login matchingThe full Distinguish Name (dn) of the Active Directory user. E.g: cn=Admin,cn=Users,dc=localN/A
Active Directory password matchingThe password of the login matchingN/A


The Active Directory application comes with a set of default values configured, so the user only needs to specify the Base DN and the setup is done.


Active Directory Base DNThe Base DN is the root of the tree where the server performs the search. E.g: dc=localN/A


In order to provide a custom configuration to the application, click on Show Advanced Configuration and start exploring all the available options.



Enable the Active Directory authentificationIf enabled and configured properly, a local user will be created whenever an Active Directory user visit this wiki for the first timeYes
Active Directory UID attribute nameSpecifies the Active Directory attribute containing the identifier to be used as the XWiki user name.sAMAccountName
Active Directory user fields mappingSpecifies the Active Directory attribute that contains the photo image. last_name=sn,first_name=givenName,
Active Directory groups mappingMap an Active Directory group to a XWiki group. E.g: XWiki.XWikiAdminGroup->cn=Admin,ou=Groups,dc=localN/A


Restrict to groupOnly the members of the following Active Directory group can authenticate. If you leave empty, all the users from the Base DN will be verified. E.g: cn=Devs,ou=Grups,dc=localN/A
Active Directory group to excludeThe users that are member of the following group can't authenticate. E.g: cn=Designers,ou=Grups,dc=localN/A
Try local loginIf Active Directory authentication fails for any reason, try XWiki DB authentication with the same credentialsYes
Update user from Active Directory after loginIf 'Yes', update the mapped attributes from Active Directory to XWiki on every login, else the mapping will be updated only when the user is created.Yes
Update user photo from LDAPIf 'Yes', the XWiki avatar will be synchronized with the Active Directory on every login, else the photo will not be updated.No
Active Directory groups cache expirationTime in seconds after which the list of members in a group is refreshed from Active Directory.21600 (6 hours)
When to synchronize the Active Directory groupsSynchronize groups at creation or always (at each authentication of a user).Always

Installation Steps

This paid extensions requires XWiki 8.4 or above. In order to install the extension, follow the next steps inside your XWiki instance (on cloud or on premise).

Navigate to the Extension Manager

In the Applications Panel click on "More Applications..." and then "Install new applications...". Alternatively navigate directly to the Administration and select the "Extensions" section.


Install the Extension

Search for the extension you wish to install and use the Install button to install it.


Get a License

Navigate to the "Licenses" section of the Administration, fill your details, look for the extension you just installed in the live table and click the buttons to get a trial license or to buy a license.


Install the License

If you have selected a trial license then you're good and there's nothing else to do. Your trial license is automatically installed.

However if you've selected to buy a license you'll be redirected to a page to perform the payment. At the end you need to come back to the "Licenses" administration section and click on the "Check for Updates" button. This will download and apply the license you bought.

Use the Extension

Start using the Extension! Refer to the extension's documentation to know how to use it.

Installing in subwikis

Each (sub)wiki can have its own UI for configuring LDAP and thus it's possible to have different settings per wiki. The only restriction is that the Active Directory application must be installed first in the main wiki before it can be installed in other subwikis.


The price is per year and varies depending on the support level and the number of users.

Support / Users 10 25 50 100 250 500 1000 2500 5000 10000 20000
Active Directory Application is part of the XWiki Pro package. Purchasing this package you will benefit from more extensions at a better price. Check the full offer in XWiki Pro!


What do you get when you purchase an XWiki extension?

1 year license

By purchasing an XWiki extension license, you'll benefit from it during one year.

Free updates

You benefit from all the extension updates during one year. You are always up to date.

Support included

If you are facing an issue, you can reach the XWiki support. Our team is always available to help.

How to Buy

To buy, install this extension from inside your XWiki instance and follow the instructions.

Release notes


Update the Licensing dependency to version 1.13.4.


Update the Licensing dependency to version 1.13.3.
Update the LDAP Application dependency to version 9.3.5.


Update the Licensing dependency to version 1.13.2.
Update the LDAP Application dependency to version 9.3.2.


Bugs fixed:
#4 Password field can't be filled in.

Update the Licensing dependency to version 1.13.1.
Update the LDAP Application dependency to version 9.2.6.


Update the Licensing dependency to version 1.13.


Update the Licensing dependency to version 1.12.2.


Update the Licensing dependency to version 1.12.1.


Update the Licensing dependency to version 1.11.


Bug fixed: Active Directory's connection parameters are not properly escaped.
Update the Licensing dependency to version 1.8.
Improve the way the message about no valid license is displayed.


Update the Licensing dependency to version 1.7.


Update the Licensing dependency to version 1.6.


Update the Licensing dependency to version 1.5.4.
Update the parent version to 8.5.
Update the LDAP Application dependency to version 9.2.5.


Update the Licensing dependency to version 1.4.4.


Update the Licensing dependency to version 1.4.3.


Update the Licensing dependency to version 1.4.2.


Update the Licensing dependency to version 1.4.1.
Update the LDAP Application dependency to version 9.2.4.


Update the Licensing dependency to version 1.4.


Update the LDAP Application dependency to version 9.2.
Update the Licensing dependency to version 1.2.
Provide default values for existing properties.
Mark in the UI the default values that will be used.
Set the sAMAccountName as default uid attribute name.
Map by default all the AD attributes that are matching an XWiki user property.
Simplify the UI by splitting the Configuration into simple and advanced.
The following translations have been updated:

  • English
  • French


Initial paid version.
Introduced the Check connection button for live validation of authentication credentials.
Enable the AD Authenticator automatically and without editing xwiki.cfg.
Enable local users by default when AD is active.

Extension details

This information is only displayed to Administrators. Your users can't see this tab.


  • GNU Lesser General Public License 2.1




  • xar

Developed by


  • Requires XWiki 8.4 or above.
Installable with the Extension Manager


  • org.xwiki.rendering:xwiki-rendering-macro-message 8.4
  • org.xwiki.platform:xwiki-platform-rendering-macro-include 8.4
  • org.xwiki.platform:xwiki-platform-rendering-macro-velocity 8.4
  • org.xwiki.contrib.ldap:ldap-api 9.3.6
  • com.xwiki.activedirectory:application-activedirectory-api 1.5.9
  • com.xwiki.licensing:application-licensing-licensor-api 1.13.8
  • org.xwiki.rendering:xwiki-rendering-macro-html 8.4
Created by Administrator on 2016/09/28 15:11
XWiki SAS Copyright © 2019