This documentation is for WSO2 Identity Server 5.3.0 . View documentation for the latest release.

Versions Compared

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 . For example, these attributes can be 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 '@' 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 [email protected]. 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 Do the following to configure the carbon.xml filethis.

  1. Open the carbon.xml file in the following path: [the <PRODUCT_HOME]HOME>/repository/conf/carbon.xml file.
  2. Look for the commented out configuration EnableEmailUserName. Uncomment the configuration to enable email authentication.

    Code Block
    languagehtml/xml
    <EnableEmailUserName>true</EnableEmailUserName>
  3. Open the identity-mgt.properties file found in the <IS_HOME>/repository/conf/identity/ directory identity-mgt.properties file and set the following property to true

    Info

    This step is required due to a known issue which that prevents the confirmation codes from being removed after they are used , when email usernames are enabled. This occurs because the '@' character (and some special characters) are not allowed in the registry. To overcome this issue, enable hashed usernames when saving the confirmation codes by configuring the properties below.

    Code Block
    languagexml
    UserInfoRecovery.UseHashedUserNames=true

    Optionally, you can also configure the following property to determine which hash algorithm to use.

    Code Block
    languagexml
    UserInfoRecovery.UsernameHashAlg=SHA-1
  4. Open the user-mgt.xml file found in the [<PRODUCT_HOME]HOME>/repository/conf/ directory user-mgt.xml file and add the following property under the relevant user store manager tag. This property determines the username validation that will be enforced when the EnableEmailUserName option is enabled. 

    Note

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

    Code Block
    languagexml
    <Property name="UsernameWithEmailJavaScriptRegEx">^[\S]{3,30}$</Property>
  5. Configure the following set of parameters in the user-mgt.xmlfile 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 are 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 the properties listed below.

     

    If the UsernameWithEmailJavaScriptRegEx property has a regular expression with the "@" symbol, it is not required to configure UsernameJavaRegEx and UsernameJavaScriptRegEx properties. The priority order to configure username regular expression properties are as follows.

     

    1. UsernameJavaRegEx
    2. UsernameWithEmailJavaScriptRegEx
    ParameterDescription

    UserNameAttribute

     

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

    Code Block
    languagehtml/xml
    <Property name="UserNameAttribute">mail</Property>
    UserNameSearchFilter

    For this you need to use 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 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-->
    UsernameJavaScriptRegEx

    *(This property is relevant to the JDBCUserStoreManager and needs to must be added in) 

    Change this property under the relevant user store manager tag as follows. This property allows you to add special characters like "@" in the user name.

    Code Block
    languagexml
    <Property name="UsernameJavaScriptRegEx">^[a-zA-Z0-9._-][email protected][a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$</Property>
    UsernameJavaRegEx

    A This is a regular expression to validate usernames. By default, strings have a length of 5 to 30. Only non-empty characters are allowed. You can provide ranges of alphabets, numbers and also ranges of ASCII values in the RegEx properties.

    Code Block
    languagexml
    <Property name="UsernameJavaRegEx">[email protected]_-{3,30}$</Property>
    Realm configurations

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

    Code Block
    languagehtml/xml
    <AdminUser>
             <UserName>[email protected]</UserName>
             <Password>admin</Password>
    </AdminUser>
Panel
titleRelated Topics

See Configuring User Stores for For more information on how to configure primary and secondary user stores, see Configuring User Stores.