Hub 2.5 Help

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:

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. Roles 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, "top": int, "total": int, "groups": [userGroup, ...] }
Last modified: 20 September 2016