Purpose

Retrieves a complete list of supported permissions.

URL

https://<myserver>:<port>/api/admin/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.

Response Definition

The response takes the following format.

{
  "permissions": [
    {
      "id": permission_id,
      "name": "permission_name",
      "description": "permission_description"
    },
    ...
  ]
}
Property Description Valid Values
"id" The ID of the permission. See Permissions and default roles.
"name" The name of the permission.

See Permissions and default roles.
"description" The description of the permission. See Permissions and default roles.

Sample Server Success Response 


      Status code: 200
      Successful response
            
{
  "permissions": [
    {
      "id": 1,
      "name": "CreateDataSource",
      "description": "May create new data sources."
    },
    {
      "id": 2,
      "name": "ViewDataSource",
      "description": "May view any data source they own (when given to a role or
user) or view an individual data source they own (when given to a data source)."
    },
    {
      "id": 3,
      "name": "ModifyDataSource",
      "description": "May modify/update any data source they own (when given to
a role or user) or modify/update an individual data source they own(when given
to a data source).",
    },
    ...
  ]
}

Sample Server Failure Response 

{
  "error": {
    "code": 222207919,
    "message": {
      "lang": "en-US",
      "value": "Problem getting Roles at this time. Please try again at another time."
    }
  }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have either the Administrator (12) or MgmtAPI (11) permission.