Get All User Groups
Request
GET /usergroups?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 user groups to skip before returning the first entry in the page. |
$top | Optional query parameter. Maximum number of user groups 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 user groups: 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 has: user — Groups with users parent: group — Subgroups of the given group subgroup: group — A group that contains given group as subgroup has: subgroup — Groups with subgroups is: allUsers — All user group 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. User groups can be ordered by the following fields: name |
Response
Response Code | Meaning |
---|---|
200 OK | Successful request. |
400 Bad Request | Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error. |
403 Forbidden | Requester has no access to the request. |
404 Not Found | Requested resource wasn't found. |
500 Internal Server Error | Failed to process request because of the server error. The response contains message describing the error. |
Response body
page
{
"skip": int, /* Requested number of user groups to skip before returning the first entry in the page */
"top": int, /* Requested maximum number of user groups to return in the page */
"total": int, /* Total number of user groups. Returned only if the total field is included as a value of the fields parameter in the query */
"usergroups": [userGroup, ...]
}