Purpose

Retrieves the effective permissions on a data source. When permissions have not been explicitly set on the data source, the effective permissions are the permissions of the user's role and any explicit permissions set for the user. When permissions have been explicitly set on the data source, the effective permissions are the same as the permissions that have been explicitly set regardless of role and user permissions.

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

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

Response Definition

The response takes the following format. The properties of the response are described in the table that follows.

{
  "permissions": [integer, integer, ...]
}
Parameter Description Valid Values
"permissions" A list of effective permissions. When permissions have not been explicitly set on the data source, the effective permissions are the permissions of the user's role and any explicit permissions set for the user. When permissions have been explicitly set on the data source, the effective permissions are the same as the permissions that have been explicitly set regardless of role and user permissions. A comma separated list of permission ID

See Data source permissions for supported permissions.

Sample Server Response


  Status code: 200
  Successful response
            

{
 "permissions": [
   2,
   3,
   4,
   5
 ]
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

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