Get All Subgroups of a User Group
Request
GET /usergroups/{user group id}/subgroups?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter | Description |
---|---|
fields | Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define the subset. |
$skip | Optional query parameter. Number of subgroups to skip before returning the first entry in the page. |
$top | Optional query parameter. Maximum number of subgroups to return in the page. |
query | Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for subgroups: id: value — A group with the given id name: groupName — A group with the given name ownRole: role — Groups that have the given role as an own role has: ownRole — Groups with own roles user: user — Groups that immediately contain the given user parent: group — Subgroups of the given group subgroup: group — A group that contains given group as subgroup has: subgroup — Groups with subgroups is: autoJoin — All groups with enabled auto join has: icon — All groups with an icon project: project — All groups from the given project access(project: project, with: role) — Has the given role in the given project access(project: project, with: permission) — Has the given permission in the given project access(project: project) — Has any permission in the given project access(with: role) — Has the given role in some project access(with: permission) — Has the given permission in some project |
orderBy | Order results. See Sorting Syntax for details. Subgroups can be ordered by the following fields: name |
Response
Response body
page
{
"skip": int, /* Requested number of subgroups to skip before returning the first entry in the page */
"top": int, /* Requested maximum number of subgroups to return in the page */
"total": int, /* Total number of subgroups. Returned only if the total field is included as a value of the fields parameter in the query */
"subgroups": [userGroup, ...]
}