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

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
The WSO2 Identity Server allows authorized administrative persons to trigger a password reset for a given user account. This may be required for the following reasonssituations:
    1. User forget The user forgets the credentials and make makes a request to administration the administrator for a password reset
    2. Credentials may get exposed to outsiders hence, the user needs to reset the password and lock the account, till then , that no one else can loginlog in.

In such situations, the user has the option of contacting the admin and based on the validity of the request, the admin can force a password reset for the user account. Once it is initiated, at the point of login, the basic authenticator processes the login request and prompts the corresponding dialogs or error messages based on account status. First, you must configure the  

The below steps describe how you can configure WSO2 Identity Server for forced password reset as described below.:  

  1. Open the output-event-adapters.xml file found in the <IS_HOME>/repository/conf directory. 
  2. Configure the relevant property values for the email server that you need to configure for this service under the <adapterConfig type="email"> tag.

    Code Block
    <adapterConfig type="email">
        <!-- Comment mail.smtp.user and mail.smtp.password properties to support connecting SMTP servers which use trust
        based authentication rather username/password authentication -->
       	<property key="mail.smtp.from"></property>
       	<property key="mail.smtp.user">abcd</property>
       	<property key="mail.smtp.password">xxxx</property>
       	<property key=""></property>
       	<property key="mail.smtp.port">587</property>
       	<property key="mail.smtp.starttls.enable">true</property>
       	<property key="mail.smtp.auth">true</property>
       	<!-- Thread Pool Related Properties -->
       	<property key="minThread">8</property>
       	<property key="maxThread">100</property>
       	<property key="keepAliveTimeInMillis">20000</property>
       	<property key="jobQueueSize">10000</property>

    Tip: The email template used to send this email notification is the AdminForcedPasswordReset template for password recovery via recovery email, and the AdminForcedPasswordResetWithOTP template for password recovery via OTP (one-time password).

    You can edit and customize the email template. For more information on how to do this, see Customizing Automated Emails.

  3. Start the Identity Server and log in to the management console with admin/ admin credentials. 
  4. Create a new user with the username "tom" and update his user profile with a valid email address and other information. 
  5. Create a new role called "test role" with login permissions and assign it to the new user, "tom". 


    Tip: You can verify this by logging in to the dashboard as Tom. The log in attempt should be successful. Log out and log back in with admin credentials.

  6. Click on Resident under Identity Providers found in the Main tab.

  7. Expand the Account Management Policies tab. 

  8. Expand the Password Reset tab. You will see the following options for forced password reset: 

    Table of Contents


Enabling this option will send an email to the user with the corresponding information. The email template for this option can be configured in the email-admin-config.xml file found in the [IS_HOME]/repository/conf/email/ directory under the AdminForcedPasswordReset tag. Follow the steps below to see a sample of how this works.

  1. Configure the properties mentioned above, start the Identity Server and navigate to the relevant interface. 
  2. Select Enable Password Reset via Recovery Email from the three options listed, and click Update.
  3. Once the option is selected, admin users can force a password reset flow by updating the claim to 'true' for the relevant users. To do this, follow the steps below:
    1. Discover the UserProfileMgtService admin service. For information on how to do this, see Calling Admin Services
    2. Create a new SOAP-UI project by importing above the WSDL: https://localhost:9443/services/UserProfileMgtService?wsdl.

    3. Use the setUserProfile method to send a SOAP request to update the claim of the project. 

      Code Block
      titleSample SOAP Request
      <soapenv:Envelope xmlns:soapenv="" xmlns:mgt="" xmlns:xsd="">
    4. Add new a new basic authorization from the SOAP-UI request window and enter valid credentials to authenticate with the identity server.

  4. Log out of the dashboard and attempt to log in as the user you created above, "Tom". The login attempt will fail and a password reset will be prompted in the form of an error message saying "Login failed! Please recheck the username and password and try again". 
  5. Log in to the email account you provided in Tom's user profile. You will see a new email with a password reset request. 
  6. Follow the link provided in the email to reset the password. You can now login log in to the dashboard successfully as Tom using the new password.