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 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.

Request Definition


{
   "currentPassword": "current_password",
   "newPassword": "new_password"
}
Parameter Description Usage Valid Values
"currentPassword" Specifies the current password Required The current password for the user account
"newPassword" Specifies a new password Required A new password that meets the requirements of the password policy

Sample Request Payload 

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

Sample Server Response 

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

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission or the ChangePassword (9) permission.