Loading...

View Entity Permissions (REST API: GET)

This operation returns a list of permissions that the logged on user has on an entity.

Request

Syntax

GET <webservice>/Security/{EntityType}/{EntityId}/Permissions?parentEntityType={parentEntityType}&parentEntityId={parentEntityId}&includeAllPermission={includeAllPermission}
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

EntityType

The type of entity to work with. For example, to return permissions on a client, set EntityType to CLIENT_ENTITY, and then set EntityId to the specific ID for the client.

Valid values:

  • COMMCELL_ENTITY
  • CLIENT_ENTITY
  • APPTYPE_ENTITY
  • INSTANCE_ENTITY
  • BACKUPSET_ENTITY
  • SUBCLIENT_ENTITY
  • CLIENT_GROUP_ENTITY
  • USER_ENTITY
  • USERGROUP_ENTITY
  • LIBRARY_ENTITY
  • STORAGE_POLICY_ENTITY
  • STORAGE_POLICY_COPY_ENTITY
  • SUBCLIENT_POLICY_ENTITY

Yes

EntityId

The system-generated ID assigned to the entity. If the entity ID is not known, use the appropriate API to retrieve it. For example, to retrieve the ID for a backupset, use the GET Backup Set API.

Yes

parentEntityType

To return permissions on an agent, you must identify the agent and the client:

When the EntityType request parameter is set to APPTYPE_ENTITY, the parentEntityType request parameter must be CLIENT_ENTITY.

/Security/APPTYPE_ENTITY/{EntityId}/Permissions?parentEntityType=CLIENT_ENTITY&parentEntityId={parentEntityId}

Yes - For agent entities

 

parentEntityId

The system-generated ID assigned to the client. This is the specific ID assigned to the client set in the parentEntityType request parameter. If the client ID is not known, use the GET Client API to retrieve it.

Yes - For agent entities

includeAllPermission

The option to include permissions from lower levels of the hierarchy in the response. For example, if the request is for a client entity and the includeAllPermission request parameter is set to true, permissions from the client and the agents, backup sets, and subclients associated with the client are included in the response.

Valid values are true and false. The default value is false.

No

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

permissionId

The ID of the security permission. For a list of valid values, see Security Permission IDs and Names.

permissions

permissionName

The name of the permission, for example, Create Alert.

permissions

Examples

Sample Request

This is the request for permissions on a client (client ID is 2).

GET <webservice>/Security/CLIENT_ENTITY/2/Permissions
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This is the request for permissions on a file system agent for a client (client ID is 2).

GET <webservice>/Security/APPTYPE_ENTITY/33/Permissions?parentEntityType=CLIENT_ENTITY&parentEntityId=2
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{
  "permissions": [{
    "permissionId": 1,
    "permissionName": "Administrative Management"
  }, {
    "permissionId": 2,
    "permissionName": "Agent Management"
  }, {
    "permissionId": 3,
    "permissionName": "Agent Scheduling"
  }]
}

Last modified: 5/17/2018 3:15:30 PM