Purpose

Retrieves tenants with which the data source is being shared.

URL

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

Method

GET

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} 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.

Response Definition

The response takes the following format.

{
  "sharedTenants": [
    {
      "tenantId": tenant_id,
      "permissions": [
        permission,
        permission,
        ...
      ]
    },
    ...
  ]
}
Property Description Valid Values
"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.
"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.

 A comma separated list of permission IDs.

See Data source permissions for supported permissions.

Sample Server Success Response 


      Status code: 200
      Successful response
            
{
  "sharedTenants": [
    {
      "tenantId": 12,
      "permissions": [
        2,
        3,
        5
      ]
    },
    {
      "tenantId": 25,
      "permissions": [
        2,
        3,
        5
      ]
    }
  ]
}

Sample Server Failure Response 

{
    "error": {
        "code": 222206951,
        "message": {
            "lang": "en-US",
            "value": "DataSource 431 is not shared with any tenants."
        }
    }
}

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 ViewDataSource (2) permission, and administrative access on the tenant with which the data source is being shared.