Documentation is now available for the Fall 2020 Update release!

Search permission sets

This endpoint is used to retrieve the list of permission sets assigned to a tenant.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/permissionSets

Sample URLs

To search partner-level permission sets:

https://{api-url}/api/v2/tenants/msp_6/permissionSets

To search client-level permission sets:

https://{api-url}/api/v2/tenants/client_8/permissionSets?pageNo=1&pageSize=100&isDescendingOrder=true&sortName=id

A set of permissions given to a user or user group to perform operation(s) on specific (or all) devices. For more information, learn how to create a permission set.

Parameters

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}id

Status code

200 OK

Sample response

{
	"results": [{
			"id": 2,
			"name": "Var Administrator",
			"description": "Administrator role for all the service operations supported VAR(s)"
		},
		{
			"id": 3,
			"name": "VAR User",
			"description": "VAR User"
		},
		{
			"id": 7,
			"name": "Auditor Manage",
			"description": "Auditor Manage"
		},
		{
			"id": 8,
			"name": "Auditor View",
			"description": "Auditor View"
		},
		{
			"id": 11,
			"name": "Partner Administrator",
			"description": "Partner Administrator"
		},
		{
			"id": 12,
			"name": "Technician",
			"description": "Technician"
		},
		{
			"id": 13,
			"name": "Dispatcher",
			"description": "Dispatcher"
		}
	],
	"totalResults": 7,
	"orderBy": "id",
	"pageNo": 1,
	"pageSize": 100,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": false
}