Search user groups

URL

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

Sample URLs

https://{api-url}/api/v2/tenants/client_2/userGroups

https://{api-url}/api/v2/tenants/msp_1/userGroups?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=userGroup.id

Note

This API provides a paginated list with minimal details of user groups.
Use Get User Group API to retrieve the assigned roles to a user group.
Use Get Users or a User Group API to retrieve the ausers that are part of a user group.

Parameters

All parameters are optional:

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

Status code

200 OK

Sample response

{
	"results": [{
			"uniqueId": "USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567",
			"name": "Lab Escalation Users",
			"description": "Network Lab Escalation Users",
			"createdTime": "2016-07-23T16:46:41+0000",
			"updatedTime": "2017-10-06T06:40:51+0000",
			"email": "joe@gmail.com"
		},
		{
			"uniqueId": "USRGRP-ab5afe06-0cca-9b8f-6053-357531f7d9ff",
			"name": "Linux Issues Support",
			"description": "Linux Issues Support Group",
			"createdTime": "2016-07-23T16:46:02+0000",
			"updatedTime": "2017-06-06T10:59:17+0000"
		}
	],
	"totalResults": 2,
	"orderBy": "userGroup.id",
	"pageNo": 1,
	"pageSize": 100,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": true
}