skip to main content
Hybrid Data Pipeline API reference : Management API : Data Sources API : Share data source with a user or users
  

Try Now
Share data source with a user or users

Purpose

Shares a data source with a user or users.
Note: An administrator can execute this operation on behalf of a user by appending the user query parameter to the request and specifying a user name. See also Managing resources on behalf of users.

URL

https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedUsers

Method

POST

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 being shared with a user or users.
The ID is auto-generated when the data source is created and cannot be changed.

Request Payload Definition

The request takes the following format.
{
"sharedUsers": [
{
"userId": user_id,
"permissions": [
permission,
permission,
...
]
},
...
]
}
Property
Description
Usage
Valid Values
"userId"
The ID of the user account with which the data source is being shared.
Required
The ID is auto-generated when the user account is created and cannot be changed.
"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.
Required
A comma separated list of permission IDs.
See Data source permissions for supported permissions.

Request Payload

{
"sharedUsers": [
{
"userId": 88,
"permissions": [
2,
3,
5
]
},
{
"userId": 89,
"permissions": [
2,
3,
5
]
}
]
}

Success Response

Status code: 201
Successful response
{
"sharedUsers": [
{
"userId": 88,
"permissions": [
2,
3,
5
]
},
{
"userId": 89,
"permissions": [
2,
3,
5
]
}
]
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have the MgmtAPI (11) and ModifyDataSource (3) permissions.