skip to main content
Hybrid Data Pipeline API reference : Management API : Data Sources API : Delete shared tenant from a data source
  

Try Now
Delete shared tenant from a data source

Purpose

Stops sharing the data source with a tenant. This operation will delete the shared tenant from the data source.
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/{tenantId}

Method

DELETE

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} and {tenantId} parameters 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.
{tenantId}
The ID of the tenant with which the data source is being shared.
The ID is auto-generated when the tenant is created and cannot be changed.

Sample Server Response

Status code: 204
Successful response
{
"success":true
}

Sample Server Failure Response


{
"error": {
"code": "222207011",
"message": {
"lang": "en-US",
"value": "Invalid DataSource ID: 1."
}
}

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.