Page Comparison

WSO2 products can be configured to authenticate users using their attributes such as email or mobile number instead of the username. This topic provides instructions on how to set up your WSO2 product to authenticate a users authenticate users by using their email.

The '@' is a special character in usernames of WSO2 products as it is used in multi-tenant environments to build the user's fully-qualified name. For example, user daniel from the tenant domain WSO2.com has the fully-qualified name daniel@WSO2.com. So before using the email username we need to configure the WSO2 products to differentiate between the '@' symbol in the user's emails and usernames. For this, we need to configure the carbon.xml file file.

Open the carbon.xml file file, which is in the following path: <ES_HOME>/repository/conf/carbon directory.xml
Look for the commented out configuration EnableEmailUserName. Uncomment the configuration to enable email authentication.
Code Block
language html/xml
<EnableEmailUserName>true</EnableEmailUserName>

Open the user-mgt.xml file found in the <ES_HOME>/repository/conf/ directory directory and configure the following.

Info
The `user-mgt.xml` file consists of configurations for the primary user store. If you are trying to configure this for a secondary user store, modify the relevant user store configuration file found in the `<ES_HOME>/repository/deployment/server/userstores` directory instead.

Configure the following set of parameters in the user-mgt.xml file under the relevant user store manager tag, depending on the type of user store you are connected to (LDAP/Active Directory/ JDBC).

Note
Note: These properties have not been added by default for the JDBCUserStoreManager. Therefore, i>f if you are using a JDBC-based user store, you need to add the properties marked with an asterisk * to the `user-mgt.xml` file under the relevant user store manager tag. For any other type of user store, simply modify the values of all the properties listed below.

Parameter Description

UserNameAttribute

* (This property is relevant to JDBCUserStoreManager)

For this, you need to set mail attribute of the user.

Code Block

language	html/xml

<Property name="UserNameAttribute">mail</Property>

UserNameSearchFilter

For this, you need to use the mail attribute of the user instead of cn or uid.

Code Block

language	html/xml

<Property name="UserNameSearchFilter">(&amp;(objectClass=identityPerson)(mail=?))</Property>

UserNameListFilter

For this, you need to use the mail attribute of the user.

Code Block

language	html/xml

<Property name="UserNameListFilter">(&amp;(objectClass=identityPerson)(mail=*))</Property>

UserDNPattern

This parameter is used to speed-up the LDAP search operations. You can comment out this config.

Code Block

language	html/xml

<!--Property name="UserDNPattern">cn={0},ou=Users,dc=wso2,dc=com</Property-->

UsernameWithEmailJavaScriptRegEx

* (This property is relevant to JDBCUserStoreManager)

Add the following property under the relevant user store manager tag. This property enables you to add special characters like "@" in the username.

Code Block

language	xml

<Property name="UsernameWithEmailJavaScriptRegEx">[a-zA-Z0-9@._-|//]{3,30}$</Property>

Realm configurations

The AdminUser username should use the email attribute of the admin user.

Code Block

language	html/xml

<AdminUser>
         <UserName>admin@wso2.com</UserName>
         <Password>admin</Password>
</AdminUser>

Open the identity.xml

...

file, which is in the <ES_HOME>/repository/conf/identity directory.

Add the following event listener in the identity.xml file.

Code Block

<EventListeners>
   <EventListener type="org.wso2.carbon.user.core.listener.UserOperationEventListener" name="org.wso2.carbon.user.mgt.workflow.userstore.UserStoreActionListener" orderId="10" enable="true" />
   <EventListener type="org.wso2.carbon.user.core.listener.UserOperationEventListener" name="org.wso2.carbon.identity.mgt.IdentityMgtEventListener" orderId="50" enable="false" />
   <EventListener type="org.wso2.carbon.user.core.listener.UserOperationEventListener" name="org.wso2.carbon.identity.scim.common.listener.SCIMUserOperationListener" orderId="90" enable="true" />
   <EventListener type="org.wso2.carbon.identity.core.handler.AbstractIdentityMessageHandler" name="org.wso2.carbon.identity.data.publisher.application.authentication.impl.DASLoginDataPublisherImpl" orderId="10" enable="false" />
   <EventListener type="org.wso2.carbon.identity.core.handler.AbstractIdentityMessageHandler" name="org.wso2.carbon.identity.data.publisher.application.authentication.impl.DASSessionDataPublisherImpl" orderId="11" enable="false" />
   <EventListener type="org.wso2.carbon.identity.core.handler.AbstractIdentityMessageHandler" name="org.wso2.carbon.identity.data.publisher.application.authentication.AuthnDataPublisherProxy" orderId="11" enable="false" />
</EventListeners>

Versions Compared

Old Version 2

New Version 3

Key