Search roles

This endpoint is used to retrieve roles under a partner or client.

Leave Feedback

URL

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

Sample URLs

To search partner-level roles:

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

To search client-level roles:

https://{api-url}/api/v2/tenants/client_8/roles/search

Parameters

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

Status code

200 OK

Sample response

{
	"results": [{
			"uniqueId": "ROLE-0074b24b-5c0b-2332-dd99-fea506f6cebd",
			"name": "Var Administrator",
			"description": "Administrator role for all the service operations supported VAR(s)",
			"defaultRole": false
		},
		{
			"uniqueId": "ROLE-1274b24b-5c0b-2332-dd99-fea506f6cebd",
			"name": "Network Administrator",
			"description": "Permissions on all Network Devices in SJ Site",
			"defaultRole": false
		},
		{
			"uniqueId": "ROLE-3474b24b-5c0b-2332-dd99-fea506f6cebd",
			"name": "Auditor Manage",
			"description": "Auditor for all Windows and Linux Devices,
			"defaultRole": false
		},
		{
			"uniqueId": "ROLE-5674b24b-5c0b-2332-dd99-fea506f6cebd",
			"name": "Auditor View",
			"description": "Auditor View",
			"defaultRole": false
		},
		{
			"uniqueId": "ROLE-7874b24b-5c0b-2332-dd99-fea506f6cebd",
			"name": "Partner Administrator",
			"description": "Partner Administrator",
			"defaultRole": true
		}
	],
	"totalResults": 5,
	"orderBy": "id",
	"pageNo": 1,
	"pageSize": 100,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": false
}