Change password

Hybrid Data Pipeline API reference : Administrators API : User Details API : Change password

Try Now

Change password

Purpose

Updates the password on the user account

URL

https://<myserver>:<port>/api/admin/userdetails/changePassword

Method

PUT

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.

Request Payload Definition

The request takes the following format. The properties of the request are described in the table that follows.

{
"currentPassword": "current_password"
"newPassword": "new_password"
}

Parameter	Description	Usage	Valid Values
"currentPassword"	Specifies the current password.	Required	The password length can be from 1 to 32 characters.
"newPassword"	Specifies a new password.	Required	The password length can be from 1 to 32 characters.

Sample Request Payload

{
"currentPassword": "Secret"
"newPassword": "NewSecret"
}

Note: Hybrid Data Pipeline also supports change password functionality where the user is not required to enter a current password when changing passwords. Administrators can enable this non-default behavior with the System Configurations API. If the secureChangePassword attribute is set to false, the request payload for change password functionality should only include "newPassword": "<mynewpassword>".

Sample Server Response

{
"passwordStatus": 2,
"passwordExpiration": "2025-12-31 00:00:00"
}

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 ChangePassword (9) permission.