skip to main content
Hybrid Data Pipeline API reference : Administrators API : Users API : Update status info on a user account

Try Now
Update status info on a user account


Updates status information on a user account





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.
"status": integer,
"accountLocked": boolean,
"accountLockedAt": "YYYY-MM-DD HH:mm:ss",
"accountLockedUntil": "YYYY-MM-DD HH:mm:ss"
Valid Values
Specifies whether the user is active.
An inactive user cannot log in to the Web UI, use APIs, or establish JDBC, ODBC, or OData connections.
0 | 1
If set to 0, the user is inactive.
If set to 1, the user is active.
Specifies whether the user account has been locked based on the password failure lockout policy.
true | false
If set to true, the account has been locked.
If set to false, the account is not locked.
Specifies the time at which the user account has been locked.
Timestamps must be in the UTC format YYYY-MM-DD HH:mm:ss.
Specifies the time until which the user account will remain locked.
Timestamps must be in the UTC format YYYY-MM-DD HH:mm:ss.

Sample Request Payload

Note: Optional properties not included in the payload request will be removed from the object.
"status": 1,
"accountLocked": false

Sample Server Response

Status code: 200
Successful response
"status": 1,
"accountLocked": false

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.