Skip to main content
Browse Documentation
HTTP - Management

Get the child groups of a group

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

Gets the direct child group members of a group.

GET/api/security/groups/{groupIdentifier}/groups?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
pageIndexquerynumberintegerThe index of the pagefalse
pageSizequerynumberintegerThe number of results per page. The default is 25.false
includeInheritedquerybooleanSet to true in order to return the direct child groups and ALL the descendant groupsfalse

Examples

Get child groups for a group by Id

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

Get child groups for a group by name

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

Get the first page of child groups and ALL descendant groups for a group, with page sizes of 10

HTTP
GET: /api/security/groups/Paper%20Street%20Soap%20Company/groups?pageIndex=0&pageSize=10&includeInherited=true

Remarks

Permissions

Member of System Administrators.

Responses

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