This documentation is for WSO2 Identity Server 5.0.0. View documentation for the latest release.
Page Comparison - User Account Recovery (v.4 vs v.5) - Identity Server 5.0.0 - WSO2 Documentation

Versions Compared


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


The sequence of service calls are described below and these are available in the service API ­https://localhost:9443/services/UserInformationRecoveryService?wsdl.

  1. Configure the the <IS_HOME>/repository/conf/security/identity­ file with the following:



    Code Block

    See the following table for descriptions of these configurations.

    This enables the identity listener.
    Configure the email­

    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.

  2. Configure the <IS_HOME>/repository/conf/email/email-admin-config.xml file with  file with the email template with the type “accountConfirmationaccountIdRecovery”. 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


    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 dialet 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 is used to search for the user. You can define the claim values returned from the getUserIdentitySupportedClaims() call 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.