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

Versions Compared


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

WSO2 products can be configured to authenticate users using their attributes. For example, these attributes can be email or mobile number instead of the username. If your organization decide to use users email as their username, this topic provides instructions on how to set up your WSO2 product to authenticate users using their email.

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


  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
  3. Open the <IS_HOME>/repository/conf/claim-config.xml file and configure the AttributeID property of the claim ID that is under <Dialect dialectURI=""> to mail.

    Code Block

    This file is checked only when WSO2 IS is starting for the first time. Therefore, if you didn't configure this property at the time of starting up the server for the first time, you get errors at the start up.

  4. Open the <IS_HOME>/repository/conf/identity/ file and set the following property to true


    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

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

    Code Block
  5. Configure the following set of parameters in the user store configuration, depending on the type of user store you are connected to (LDAP/Active Directory/ JDBC).



    Set the mail attribute of the user. LDAP/Active Directory only

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

    Use the mail attribute of the user instead of cn or uid. LDAP/Active Directory only

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

    Use the mail attribute of the user. LDAP/Active Directory only

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

    This parameter is used to speed up theLDAP the LDAP search operations. You can comment out this config. LDAP/Active Directory only

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

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

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

    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
    <Property name="UsernameJavaRegEx">^[a-zA-Z0-9._-][email protected][a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$</Property>
    Realm configurations

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

    Code Block
             <UserName>[email protected]</UserName>

    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 [email protected] is considered the super administrator. The user having the username admin is considered as a normal administrator.


    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 -Dsetup

    With these configuration users can login to supper tenant with both email user name ([email protected]) or non-email user names (alice). But for tenant only email user names allowed ([email protected]


    You can configure email user name without enabling EnableEmailUserName property, then users can login to both supper tenant and tenant using email and non-email user names. But supper tenant users should always use @carbon.super at the end of user names.

  6. Restart the server.

titleRelated Topics

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