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

Versions Compared


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


  1. Enable the Identity Listener by setting the following property to true in the <IS_HOME>/repository/conf/identity/identity.xml file.

    Code Block
    <EventListener type="org.wso2.carbon.user.core.listener.UserOperationEventListener" name="org.wso2.carbon.identity.mgt.IdentityMgtEventListener" orderId="50" enable="true"/>
  2. Configure the <IS_HOME>/repository/conf/identity/identity­ file with the following.

    Code Block

    See the following table for descriptions of these configurations.


    This enables the internal email sending module. If false, the email sending data is available to the application via a Web service. Thus, the application can send the email using its own email sender.

  3. Configure the <IS_HOME>/repository/conf/email/email-admin-config.xml file with the email template with the type “accountIdRecovery”. The following is a sample template.

    Code Block
    <configuration type="accountIdRecovery">
    	<subject>WSO2 Carbon ­ Account Recovery</subject>
    		Hi {first-­name}
    		We received a request to recover your account user name. The account associated with us indicates that the user name is : {user­-name}
    		Best Regards,
    		WSO2 Carbon Team

    Tip: You can also customize the email template through the WSO2 IS management console in other languages. For more information on how to do this, see Customizing Automated Emails.

    1. getUserIdentitySupportedClaims() -­ This method returns all the claims defined in the Identity Server which are supported and not read only. You need to give the dialect which is by default “”.
    2. getCaptcha() -­ Get the captcha for the current request.
    3. verifyAccount() -­ Verifies the captcha, user claim values and tenant domain which are used to search for the user. You can define the claim values returned from the getUserIdentitySupportedClaims() call. Hence, you can define which claims should be used in the verification by passing only those required. Upon successful verification, the user id is sent by email to the user. Also, this returns the success/failed status of the verification.