Get the child groups of a group
Log in to add to favouritesGET/api/security/groups/{groupIdentifier}/groups?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 | |
| pageIndex | query | number | integer | The index of the page | false | |
| pageSize | query | number | integer | The number of results per page. The default is 25. | false | |
| includeInherited | query | boolean | Set to true in order to return the direct child groups and ALL the descendant groups | false |
Responses
Examples
Get child groups for a group by Id
1GET: /api/security/groups/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c/groupsGet child groups for a group by name
1GET: /api/security/groups/Paper%20Street%20Soap%20Company/groupsGet the first page of child groups and ALL descendant groups for a group, with page sizes of 10
1GET: /api/security/groups/Paper%20Street%20Soap%20Company/groups?pageIndex=0&pageSize=10&includeInherited=true