Site users management - Send reset password email to users

Use this method to send a reset password email to user(s)

Request URI

PUT /api/3/sites/{siteid}/users/resetpassword

Request Parameters

Request Body 

A list of user ids to send password reset emails. 

Send a transaction id's object to send a list of user id's. The userid can be obtained by calling the get all site users API.

Response

The server will respond with a 200 OK http response in the case of success, and a (4xx/5xx) response in the case of a partial success or complete failure

The response body will contain transaction status information for each user

Notes : 

      1) In the case of success, it will display the message "Successfully sent the reset password email"

      2) When a user id is not correct, it will display the message "User Id provided is invalid"

      3) When a given user id is not a site participant, it will display the message "User with the specified user ID does not exist in the site"

      4) When a user id has already requested a password reset email and then requests it again it will display the message "User with this User ID has already been sent a reset password email "

      5) When a user id is not in the system or a user is not active, it will display a message "User with this user ID does not exist in system or the user is not active"

      6) When the site is archived or a user does not have access to the site, it will display the message "Site is archived or user does not have access to the site "

      7)  In any other case of exception, it will display the message "Internal server error"