Get All Groups of a User
Request
GET <REST API URL>/users/{user id}/groups?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 subset. |
$skip | Optional query parameter. Number of roles to skip before returning first entry of the page. |
$top | Optional query parameter. Max number of roles 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 Groups: 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 has: ownRole — Groups with own roles has: subgroup — Groups with subgroups has: icon — All groups with an icon id: value — A group with the given id is: autoJoin — All groups with enabled auto join name: groupName — A group with the given name ownRole: role — Groups that have the given role as an own role parent: group — Subgroups of the given group project: project — All groups from the given project subgroup: group — A group that contains given group as subgroup |
orderBy | Order results. See Sorting Syntax for details. Roles can be ordered by the following fields: name |
Response
Response body
page
{ "skip": int, "top": int, "total": int, "groups": [userGroup, ...] }