skip to main content
Hybrid Data Pipeline API reference : Management API : Data Sources API : Update permissions on a data source
  

Try Now
Update permissions on a data source

Purpose

Updates the permissions on a data source. This operation can only be executed by an administrator on behalf of a user by including the user query parameter in the request and specifying the user name.

URL

https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/permissions?user=<userName>
where <userName> is the name of the user for whom permissions on the data source are being updated. The user must be the owner of the data source.

Method

PUT

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 {datasourceId} parameter must also be specified in the URL.
Parameter
Description
Valid Values
{datasourceId}
The ID of the data source.
The ID is auto-generated when the data source 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.
{
"permissions": [integer, integer, ...]
}
Parameter
Description
Usage
Valid Values
"permissions"
A list of permissions associated explicitly with the data source. Permissions can only be set on a data source by an administrator when creating or updating the data source on behalf of a user.
Any permissions specified for this data source will override the permissions for the user or the user's role that own this data source. You must specify the exact set of permissions that you want to set for this data source as no permissions are inherited from the user or user's role if permissions are specified on a data source.
Permissions set on a group data source override permissions set on any of its member data sources.
Required
A comma separated list of permission ID
See Data source permissions for supported permissions.

Sample Request Payload

{
"permissions": [
2,
3,
4,
5
]
}

Sample Server Response


Status code: 200
Successful response
{
"permissions": [
2,
3,
4,
5
]
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

Permissions: The administrator must have the Administrator (12) permission; or the administrator must have administrative access on the tenant to which the user belongs, the MgmtAPI (11) permission, the OnBehalfOf (21) permission, and the ModifyDataSource (3) permission.