Purpose

Updates password information on a user account. This call cannot be used to reset the password. See Reset the password on a user account for information on resetting a user's password.

URL

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

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

{
   "passwordStatus": integer,
   "passwordExpiration": "YYYY-MM-DD HH:mm:ss"
}
Property Description Usage Valid Values
"passwordStatus" Specifies whether the password is active. Required 1 | 2

If set to 1, the password is active.

If set to 2, the password must be reset.
"passwordExpiration" Specifies the date when the password expires. Optional Timestamps must be in the UTC format YYYY-MM-DD HH:mm:ss.

If null, the password has no expiration.

Sample Request Payload

Note: Optional properties not included in the payload request will be removed from the object.
{
   "passwordStatus": 2,
   "passwordExpiration": "2025-12-31 00:00:00"
}

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 ModifyUsers (15) permission and administrative access on the tenant.