skip to main content
Hybrid Data Pipeline API reference : Administrators API : Users API : Reset the password on a user account

Try Now
Reset the password on a user account


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 Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <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.
Valid Values
The ID of the user account
The ID is auto-generated when the user account is created and cannot be changed.

Request Payload Definition

The request takes the following format. The properties of the request are described in the table that follows.
"newPassword": "temporary_password"
Valid Values
A temporary password provided by the administrator
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

"value":"There is no User with that id: 123."


Basic Authentication using Login ID and Password


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