Purpose

Retrieves users with whom the data source is being shared.

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

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

Response Definition

The response takes the following format.

{
  "sharedUsers": [
    {
      "userId": user_id,
      "permissions": [
        permission,
        permission,
        ...
      ]
    },
    ...
  ]
}
Property Description Valid Values
"userId" The ID of the user account with which the data source is being shared. 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.

 A comma separated list of permission IDs.

See Data source permissions for supported permissions.

Sample Server Success Response 


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

Sample Server Failure Response 

{
    "error": {
        "code": 222207093,
        "message": {
            "lang": "en-US",
            "value": "DataSource 5441 is not shared with any users."
        }
    }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the MgmtAPI (11) and ViewDataSource (2) permissions.