Active Directory Application
Authenticate users against an Active Directory server (LDAP). Note that this is a paying application.
| Category | Application |
| Active Installs | 41 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Sources | Issues |
The Active Directory application is designed to be used for synchronization of the users and groups from XWiki and Active Directory server. With this application, users will be able to authenticate on XWiki using the credentials from Active Directory server instead of creating new XWiki accounts.
UI Administration page
In order to access the Active Directory UI, go to Administration and look in the Other category.
Connection settings
The Check connection button helps to check in real time that the authentication credentials are correct.
| Field | Description | Default | |
|---|---|---|---|
| Active Directory server address | The address of the Active Directory server | 127.0.0.1 | |
| Active Directory server port | The port of the Active Directory server | 389 | |
| Active Directory server login matching | The full Distinguish Name (dn) of the Active Directory user. E.g: cn=Admin,cn=Users,dc=local | N/A | |
| Active Directory password matching | The password of the login matching | N/A |
Configuration
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.
| Field | Description | Default | |
|---|---|---|---|
| Active Directory Base DN | The Base DN is the root of the tree where the server performs the search. E.g: dc=local | N/A |
Advanced
In order to provide a custom configuration to the application, click on Show Advanced Configuration and start exploring all the available options.
| Field | Description | Default |
|---|---|---|
| Enable the Active Directory authentification | If enabled and configured properly, a local user will be created whenever an Active Directory user visit this wiki for the first time | Yes |
| Active Directory UID attribute name | Specifies the Active Directory attribute containing the identifier to be used as the XWiki user name. | sAMAccountName |
| Active Directory user fields mapping | Specifies the Active Directory attribute that contains the photo image. | last_name=sn,first_name=givenName, email=mail,company=company, comment=comment,phone=mobile |
| Active Directory groups mapping | Map an Active Directory group to a XWiki group. E.g: XWiki.XWikiAdminGroup->cn=Admin,ou=Groups,dc=local | N/A |
| Field | Description | Default |
|---|---|---|
| Restrict to group | Only 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=local | N/A |
| Active Directory group to exclude | The users that are member of the following group can't authenticate. E.g: cn=Designers,ou=Grups,dc=local | N/A |
| Try local login | If Active Directory authentication fails for any reason, try XWiki DB authentication with the same credentials | Yes |
| Update user from Active Directory after login | If '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 LDAP | If '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 expiration | Time 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 groups | Synchronize groups at creation or always (at each authentication of a user). | Always |
Installation Steps
This paid extensions requires XWiki 11.10 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 Paid Apps on Subwikis
If you want to install an application on the whole farm (main wiki + subwikis), you can do so directly from the main wiki’s Extension Manager, as seen below:
Extensions can also be installed only on a particular subwiki by global admins. Subwiki admins will not be able to install these extensions due to their limited rights.
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.
Options
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 |
|---|---|---|---|---|---|---|---|---|---|---|---|
| Silver |
Benefits
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
v1.5.6
Update the Licensing dependency to version 1.13.2.
Update the LDAP Application dependency to version 9.3.2.
v1.5.5
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.
v1.5.4
Update the Licensing dependency to version 1.13.
v1.5.3
Update the Licensing dependency to version 1.12.2.
v1.5.2
Update the Licensing dependency to version 1.12.1.
v1.5.1
Update the Licensing dependency to version 1.11.
v1.5
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.
v1.4
Update the Licensing dependency to version 1.7.
v1.3
Update the Licensing dependency to version 1.6.
v1.2.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.
v1.2.5
Update the Licensing dependency to version 1.4.4.
v1.2.4
Update the Licensing dependency to version 1.4.3.
v1.2.3
Update the Licensing dependency to version 1.4.2.
v1.2.2
Update the Licensing dependency to version 1.4.1.
Update the LDAP Application dependency to version 9.2.4.
v1.2.1
Update the Licensing dependency to version 1.4.
v1.2
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
v1.1
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
License
- GNU Lesser General Public License 2.1
Sources
Issues
Type
- xar
Developed by
Compatibility
- Requires XWiki 8.4 or above.
Dependencies
- 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.2
- com.xwiki.activedirectory:application-activedirectory-api 1.5.6
- com.xwiki.licensing:application-licensing-licensor-api 1.13.2
- org.xwiki.rendering:xwiki-rendering-macro-html 8.4