Update data source permissions for shared user
- Last Updated: February 2, 2024
- 1 minute read
- Hybrid Data Pipeline
- Version 5.0
- Documentation
Purpose
Updates the data source permissions for a user with whom the data source is being shared.
URL
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedUsers/{userId}
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 {datasourceId} and {userId} parameters must also be specified in the URL.
| Parameter | Description | Valid Values |
|---|---|---|
| {datasourceId} | The ID of the data source being shared with a user or users. | The ID is auto-generated when the data source is created and cannot be changed. |
| {userId} | The ID of the user with whom the data source is being shared. | The ID is auto-generated when the user account is created and cannot be changed. |
Request Definition
{
"permissions": [
permission,
permission,
...
]
}
| Property | Description | Valid Values |
|---|---|---|
| "permissions" | A list of data source permissions granted to the
shared user account. The shared user will only be able to execute
operations against the data source that correspond to the
permissions granted. The data source owner must specify the exact set of permissions for shared users as no permissions are inherited from the user or user's role. |
A comma separated list of permission IDs. 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
The user must have the MgmtAPI (11) and ModifyDataSource (3) permissions.