cogXWiki authenticator based on a configurable field instead of the user identifier
TypeJAR
Category
Developed by

Thomas Mortagne

Active Installs3
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

Require XWiki 8.4+

Installable with the Extension Manager

Description

This authenticator allow to use a custom field ("email" by default) in the login form instead of the user identifier.

Enable the authenticator

xwiki.authentication.authclass=org.xwiki.contrib.authentication.customfield.CustomFieldAuthenticator

Configure the authenticator

In xwiki.properties file:

#-# Indicate the field on which to validate the user identifier.
#-# 
#-# The default is:
# authentication.customfield.field=email

#-# Indicate the field on which to validate the user identifier.
#-# 
#-# The default is true except for the following fields:
#-# * email
#-# 
# authentication.customfield.caseSensitive=true

#-# Indicate if the authenticator should fallback on standard XWiki authenticator if login fail with the custom field.
#-# 
#-# The default is:
# authentication.customfield.falllback=true

Troubleshooting

What happen when several users have the same uid ?

If you have several user who already have the same uid before the authenticator is installed then the login with this id might be a bit random depending on the order in the database (which can change for various reasons) and you will get a warning in the application server log explaining it.

Once the authenticator is installed and configured this situation is prevented by a listener which cancel any user profile save with a duplicate uid.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

Release Notes

v1.1.1

v1.1

v1.0.5

v1.0.3

v1.0.1

Dependencies

Dependencies for this extension (org.xwiki.contrib.authentication:authenticator-customfield 1.1.1):

  • org.xwiki.platform:xwiki-platform-oldcore 8.4
Tags:
    

Get Connected