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}&zenQL={zenQL}&excludedGroups={excludedGroups}&includeSelf={includeSelf}
Parameters
| Name | Parameter type | Type | Format | Description |
|---|---|---|---|---|
| groupIdentifier(required) | path | string | group identifier | For convenience, Group resources can be referenced by using either the group name or id |
| order | query | string | - | A comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order. |
| pageIndex | query | number | integer | The index of the page. |
| pageSize | query | number | integer | The number of results per page. The default is 25. |
| includeInherited | query | boolean | - | Set to true in order to return the direct child groups and ALL the descendant groups |
| zenql | query | string | - | ZenQL query to select the groups returned in the listing |
| excludedGroups | query | string | - | A comma-separated list of group identifiers such as Guid ids or names whose children will be excluded from the returned values |
| includeSelf | query | boolean | - | Whether to include the group for which children are being requested in the returned groups |
Responses
Examples
Get child groups for a group by Id
GET: /api/security/groups/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c/groupsGet child groups for a group by name
GET: /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
GET: /api/security/groups/Paper%20Street%20Soap%20Company/groups?pageIndex=0&pageSize=10&includeInherited=trueGet the first page of child groups and ALL descendant groups for a group, including the parent group, but only if they were created in the last seven days and excluding certain groups
GET: /api/security/groups/Paper%20Street%20Soap%20Company/groups?includeInherited=true&zenQL=created>now(-7)&excludedGroups=0617b0ac-4dda-4279-b070-5930511c86e0,37394083-ff04-4ecb-b8ac-1f6e7a26c875&includeSelf=trueRemarks
Permissions
Member of System Administrators.