Share data source with a tenant or tenants

Hybrid Data Pipeline API reference : Management API : Data Sources API : Share data source with a tenant or tenants

Purpose

Shares data source with a tenant or tenants.

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}/sharedTenants

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 tenant or tenants.	The ID is auto-generated when the data source is created and cannot be changed.

Request Payload Definition

The request takes the following format.

{
"sharedTenants": [
{
"tenantId": tenant_id,
"permissions": [
permission,
permission,
...
]
},
...
]
}

Property	Description	Usage	Valid Values
"tenantId"	The ID of the tenant with which the data source is being shared.	Required	The ID is auto-generated when the tenant is created and cannot be changed.
"permissions"	A list of data source permissions granted to all user accounts which belong to the tenant. The users in the tenant 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 as no permissions are inherited from the users or users' roles.	Required	A comma separated list of permission IDs. See Data source permissions for supported permissions.

Request Payload

{
"sharedTenants": [
{
"tenantId": 12,
"permissions": [
2,
3,
5
]
},
{
"tenantId": 25,
"permissions": [
2,
3,
5
]
}
]
}

Success Response

Status code: 201
Successful response

{
"sharedTenants": [
{
"tenantId": 12,
"permissions": [
2,
3,
5
]
},
{
"tenantId": 25,
"permissions": [
2,
3,
5
]
}
]
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The data source owner must have either the Administrator (12) permission; or the MgmtAPI (11) permission, the ModifyDataSource (3) permission, and administrative access on the tenant with which the data source is being shared.