Developer Portal for YouTrack and Hub Help

Subgroups of a Specific Group

This resource provides access to subgroups that belong to a specific group.

Resource

<Hub Service URL>/api/rest/usergroups/{groupID}/subgroups

Returned entity

UserGroup. For the description of the entity attributes, see UserGroup Attributes.

Supported methods

Group Attributes

Represents a group in Hub and YouTrack.

Attributes

This table describes attributes of the UserGroup entity.

  • To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

id

String

The unique identifier of the group. Read-only.

aliases

Set.<alias>

The set of IDs of user groups that have been merged into this group.

allUsers

Boolean

true if this is the All Users group. This is a special unique group that always includes all user accounts in the system.

autoJoin

Boolean

Determines whether new users are added to this group automatically.

autoJoinDomain

String

Stores an optional email domain used for auto-joining users to this group. If the user's email belongs to this domain, they are added to this group automatically.

description

String

The description of the group.

iconUrl

String

The URL of the icon of the group.

name

String

The name of the group.

organizations

Set.<organization>

The list of organizations that this group belongs to.

ownUsers

Set.<user>

The list of users that belong to this group directly.

parent

userGroup

The parent group that this group belongs to.

project

Set.<project>

The list of projects in which the group is used as a resource.

projectRoles

Set.<projectRole>

The list of project roles assigned to the users of this group.

subgroups

Set.<userGroup>

The list of groups that belong to this group as sub-groups.

userCount

Integer

The number of users that belong to the group.

users

Set.<user>

The list of all users that belong to this group.

Read a List of Subgroups

Get all subgroups of a group that match the specified query.

Request Syntax

GET <Hub Service URL>/api/rest/usergroups/{groupID}/subgroups?{fields}&{$top}&{$skip}&{query}&{orderBy}

Request Parameters

Parameter

Type

Description

fields

String

Optional. Returns only the specified subset of the fields for each group. Use Fields Syntax to define the subset.

$skip

Int

Optional. Lets you set a number of returned entities to skip before returning the first one.

$top

Int

Optional. Lets you specify the maximum number of UserGroups that are returned in the response.

query

String

Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the UserGroup fields and tuples, see Hub REST API Reference.

orderBy

String

Optional Returns the list of Users sorted by a specified field. See Sorting Syntax for details. UserGroups support ordering by the following fields: name.

Sample

Request

https://example.youtrack.cloud/hub/api/rest/usergroups/9ed6d2e0-fa56-4765-92e1-3b6d7b4c81b8/subgroups?fields=id,name,users(id,login),projectRoles(id,project(name),role(name))&top=100

Response Body

{ "type": "UsergroupsPage", "next": "https://example.youtrack.cloud/hub/api/rest/usergroups/9ed6d2e0-fa56-4765-92e1-3b6d7b4c81b8/subgroups?%24skip=100&amp;amp;%24top=100", "skip": 0, "top": 100, "usergroups": [ { "type": "userGroup", "id": "0e515027-3666-4e37-868f-272fdbae89ff", "name": "Monitoring Staff", "projectRoles": [ { "type": "projectRole", "id": "6934bda9-5ffb-4029-9d14-2c31230a12df", "role": { "name": "Contributor", "immutable": false }, "project": { "name": "Monitoring" } } ], "users": [ { "type": "user", "id": "7a1573d6-a39e-4724-80e7-081acb8d2c99", "login": "william.johnson" }, { "type": "user", "id": "55bf83fc-a8c4-47d0-ab72-f39ca7461a55", "login": "Jane.Doe" } ] } ] }

Add a Subgroup

Add a subgroup to a group.

Required fields: id.

Request Syntax

POST <Hub Service URL>/api/rest/usergroups/{groupID}/subgroups?fields=string

Request Parameters

Parameter

Type

Description

fields

String

A list of UserGroup attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Sample

Request

https://example.youtrack.cloud/hub/api/rest/usergroups/4fg27fe4-f780-4a61-9eff-2fe797b9b9f4?fields=id,name,users(login)

Request Body

{ "id": "6f81ed24-f68c-41aa-a355-9d4db78d49c3", "name": "Accounting" }

Response Body

{ "type": "userGroup", "id": "a17c8030-6f4e-409e-848e-f5c2b711e6af", "name": "Helpdesk", "users": [ { "type": "user", "login": "root" }, { "type": "user", "login": "john.smith" }, { "type": "user", "login": "minnie" } ] }
Last modified: 8 February 2024