This documentation is for WSO2 Identity Server 5.3.0. View documentation for the latest release.
Page Comparison - Using Email Address as the Username (v.21 vs v.22) - Identity Server 5.3.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: DOCUMENTATION-5546

...

'@' is a special character in WSO2 products, since its used to differentiate username from tenant domain, in multi-tenant environments. 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 tenant domain separator. Do the following to configure this.

Note

Configuring email as user in already running IS server is not the production recommended way.

  1. Open the <PRODUCT_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 <IS_HOME>/repository/conf/identity/identity-mgt.properties file and set the following property to true

    Info

    This step is required due to a known issue 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 <PRODUCT_HOME>/repository/conf/user-mgt.xml file and add the following propertyunder the relevant user store manager tag, such as ReadWriteLDAPUserStoreManager, ActiveDirectoryUserStoreManager or any other 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_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 are not 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

    For more information on these properties, click here.

    ParameterDescription

    UserNameAttribute


    Set the mail attribute of the user.

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

    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

    Use the mail attribute of the user.

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

    This parameter is used tospeedupthe 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

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

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

    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">a-zA-Z0-9@._-{3,30}$</Property>
    Realm configurations

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

    Code Block
    languagehtml/xml
    <AdminUser>
             <UserName>admin@wso2.com</UserName>
             <Password>admin</Password>
    </AdminUser>
    Note

    Before this configuration, the user having the username admin and password admin was considered the super administrator. The super administrator user cannot be deleted.

    After this configuration, the user having the username admin@wso2.com is considered the super administrator. The user having the username admin is considered as a normal administrator.

    Tip

    If you changed the password of the admin user to something other than 'admin', start the WSO2 IS server using the -Dsetup parameter as seen in the command below.

    Code Block
    sh wso2server.sh -Dsetup

...