Versions Compared

Old Version 12

changes.mady.by.user Former user

Saved on

compared with

New Version 13

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 by using their email.

...

The next configuration file we you need to modify is the user-mgt.xml which can be found in the path: [PRODUCT_HOME]/repository/conf/user-mgt.xml

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 [PRODUCT_HOME]/repository/deployment/server/userstores directory instead.

You may be connected to an LDAP or Active Directory or maybe to a JDBC-based user store. So regardless of the user store manager being used, focus on the following set of configuration parameters of the user store managers.

Note

Note: These properties have not been added by default for the JDBCUserStoreManager. Therefore, 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.

ParameterDescription

UserNameAttribute

* (This property is relevant to JDBCUserStoreManager)

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

Code Block
languagehtml/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
languagehtml/xml
<Property name="UserNameSearchFilter">(&amp;(objectClass=identityPerson)(mail=?))</Property>
UserNameListFilter

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

Code Block
languagehtml/xml
<Property name="UserNameListFilter">(&amp;(objectClass=identityPerson)(mail=*))</Property>
UserDNPattern

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

Code Block
languagehtml/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 user name.

Code Block
languagexml
<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
languagehtml/xml
<AdminUser>
         <UserName>admin@wso2.com</UserName>
         <Password>admin</Password>
</AdminUser>

...