Skip to main content
Browse Documentation
HTTP - Management

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

NameParameter typeTypeFormatDescriptionExampleRequired
groupIdentifierpathstringgroup identifierFor 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
orderquerystringA comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order.-version.modifiedfalse
pageSizequerynumberintegerThe number of results per page. The default is 25.false
pageIndexquerynumberintegerThe index of the pagefalse
includeInheritedquerybooleanSpecify to include the users of all the descendant groupsfalse

Examples

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

Remarks

Permissions

Member of System Administrators.

Responses

HTTP status codeReasonModel
200SuccessPagedList<User>
401UnauthorizedError
403ForbiddenError
404Group not foundError
500Internal server errorError