Skip to main content

Get users in a group

Log in to add to favourites
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

Responses

HTTP status codeReasonModel
200SuccessUser
401UnauthorizedError
403ForbiddenError
404Group not foundError
500Internal server errorError

Examples

Get users in a group by Id

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

Get users in a named group

HTTP
1
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
1
GET: /api/security/groups/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c/users?pageIndex=0&pageSize=10&includeInherited=true

Remarks

Still need help?

New support request