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

Try Now
Update permissions on a user account


Updates permissions 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.
"roles": [integer, integer, ...],
"permissions": [integer, integer, ...]
Valid Values
A role or list of roles associated with the user account. A user account must have at least one assigned role, and may only be assigned roles from its tenant.
The ID of the role assigned to the user account, or a comma separated list of role IDs assigned to the user account.
A permission or list of permissions granted explicitly on the user account, in addition to those based on assigned roles.
The ID of the permission granted, or a comma-separated list of permissions granted, to the user account.

Sample Request Payload

Note: Optional properties not included in the payload request will be removed from the object.
"roles": [ 1, 2, ... ],
"permissions": [ 1, 2, ... ]

Sample Server Success Response

Status code: 200
Successful response
"roles": [ 1, 2, ... ],
"permissions": [ 1, 2, ... ]

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.
Note: Administrator users cannot grant permissions they do not have to other user accounts.