Purpose

Returns password information on a user account. This call cannot be used to retrieve the password.

URL

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

Method

GET

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.

Response Definition

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

{
   "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 Server Success Response

Note: The response will not return settings for optional properties that were not set in a previous POST or PUT request.

      Status code: 200
      Successful response
            
{
   "passwordStatus": 1,
   "passwordExpiration": "2020-02-02 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 ViewUsers (14) permission and administrative access on the tenant.