Purpose

Resets the password on a user account. Making this call changes the password and sets the passwordStatus to 2 (reset). The end user must change the password when he or she next logs in. Users can change their passwords either through the Web UI or through the User Details API.

URL

https://<myserver>:<port>/api/admin/users/{id}/resetpassword

Method

PUT

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

The URL parameter "id" described in the following table is required.
Parameter Description Valid Values
"id" The ID of the user account The ID is auto-generated when the user account is created and cannot be changed.

Request Definition

{
   "newPassword": "temporary_password"
}
Property Description Usage Valid Values
"newPassword" A temporary password provided by the administrator Required A string with a maximum length of 32 characters

Sample Request Payload 

{
   "newPassword": "tempsecret"
}

Sample Server Response 


      Status code: 204
      No Content

Sample Server Failure Response 

{
   "error":{
      "code":222207916,
      "message":{
         "lang":"en-US",
         "value":"There is no User with that id: 123."
      }
   }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission, or the ModifyUsers (15) permission and administrative access on the tenant.