Hub 2017.4 Help

Get All Auto Join Groups of a Auth Module

Request

GET <REST API URL>/authmodules/{auth module id}/autojoingroups?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 AutoJoinGroups:

access(project: project, with: role) — Groups that have the given role in the given project

access(project: project, with: permission) — Groups that have the given permission in the given project

access(project: project) — Groups that have some role in the given project

access(with: role) — Groups that have the given role in some projects

access(with: permission) — Groups that have the given permission in some projects

has: ownRole — Groups with own roles

has: user — Groups with users

has: subgroup — Groups with subgroups

has: icon — Groups with an icon

id: value — Group with the given ID

is: allUsers — All user group

is: autoJoin — Groups with enabled auto join

is: team — Groups that are teams

name: groupName — 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 — Groups from the given project

subgroup: group — Group that contains the given group as subgroup

team: team — Groups included to the given project team

user: user — Groups that immediately contain the given user

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, "autojoingroups": [userGroup, ...] }
Last modified: 21 February 2018