Get users in a group

Created by c.neale, last modified by zengenti on 21 Jun 2022

Gets the users as direct members of a group.

GET/api/security/groups/{groupIdentifier}/users?order={order}&pageIndex={pageIndex}&pageSize={pageSize}&includeInherited={includeInherited}

Parameters

Name	Parameter type	Type	Format	Description	Example	Required
groupIdentifier	path	string	group identifier	For convenience, Group resources can be referenced by using either the group name or id	"Paper Street Soap Company" or "82f73a9b-2a13-4d63-bcc1-e8ee5047b01c"	true
order	query	string		A comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order.	-version.modified	false
pageSize	query	number	integer	The number of results per page. The default is 25.		false
pageIndex	query	number	integer	The index of the page		false
includeInherited	query	boolean		Specify to include the users of all the descendant groups		false

Get users in a group by Id

HTTP

GET: /api/security/groups/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c/users

Get users in a named group

HTTP

GET: /api/security/groups/Paper%20Street%20Soap%20Company/users

Get the first page of users in a group and all the group's descendant groups, with page sizes of 10

HTTP

GET: /api/security/groups/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c/users?pageIndex=0&pageSize=10&includeInherited=true

Permissions

Member of System Administrators.