Get permissions on a user account

Hybrid Data Pipeline API reference : Management API : Management Permissions API : Get permissions on a user account

Purpose

Retrieves the user's 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/permissions

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.

Response Definition

The response takes the following format.

{
"userId": user_account_id,
"permissions": [permission_id, permission_id, ...]
}

Property	Description	Valid Values
"userId"	The ID of the user account.	The ID is auto-generated when the user account is created and cannot be changed.
"permissions"	A list of effective permissions granted to the user account. Effective permissions for a user account are the sum of the permissions granted to the role(s) associated with the account and the permissions granted explicitly on the account.	A comma separated list of permission IDs. See Permissions and default roles for a list of supported permissions.

Sample Server Success Response

Status code: 200
Successful response

{
"userId": 86,
"permissions": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
}

Sample Server Failure Response

{
"error":{
"code":222207031,
"message":{
"lang":"en-US",
"value":"Invalid Progress ID userName."
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the MgmtAPI (11) permission.