skip to main content
Hybrid Data Pipeline API reference : Administrators API : Administrator Permissions API : Get details on a permission
  

Try Now
Get details on a permission

Purpose

Retrieves details on a permission.

URL

https://<myserver>:<port>/api/admin/permissions/{id}

Method

GET

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 URL parameter {id} is required.
Parameter
Description
Valid Values
{id}
The ID of a permission.

Response Definition

The response takes the following format.
{
"id": permission_id,
"name": "permission_name",
"description": "permission_description"
}
Property
Description
Valid Values
"id"
The ID of the permission
"name"
The name of the permission
"description"
The description of the permission

Sample Server Success Response


Status code: 200
Successful response
{
"id": 1,
"name": "CreateDataSource",
"description": "May create new data sources"
}

Sample Server Failure Response

{
"error":{
"code":222208553,
"message":{
"lang":"en-US",
"value":"There is no Permission with that id: 1234"
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

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