Operations with a Specific Group of a User
warning
This is a Hub REST API method, which uses the Hub REST API URL.
We're including this page in the YouTrack REST API section for reference. For more details, see Hub REST API reference.
This resource lets you work with a specific group where a user belongs.
Resource |
|
Returned entity | UserGroup. For the description of the entity attributes, see Group 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. |
aliases | Set.<alias> | The set of IDs of user groups that have been merged into this group. |
allUsers | Boolean | |
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 Specific Group of a User
Get a specific group where the user belongs to.
tip
Requires permissions: Read User Basic, Read Group
Request Syntax
GET <Hub Service URL>/api/rest/users/{userID}/groups/{groupsID}?{fields}
Request Parameters
Parameter | Type | Description |
---|---|---|
fields | String | Optional. Returns only the specified subset of the fields for each user. Use Fields Syntax to define the subset. |
Sample
Request
https://example.youtrack.cloud/hub/api/rest/users/7a0563d6-a39e-4724-80e7-081acb8d2c99/groups/9d3d19df-755d-4bc0-84fe-675d79e8c49a?fields=id,name
Response Body
{
"type": "userGroup",
"id": "9d3d19df-755d-4bc0-84fe-675d79e8c49a",
"name": "Admins"
}
Remove a Specific Group from Groups of a User
Remove a group from the list of groups where the user belongs.
tip
Requires permissions: Update User, Update Group
Request Syntax
DELETE <Hub Service URL>/api/rest/users/{userID}/groups/{groupID}?fields=string
Request Parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of User attributes that should be returned in the response. If no field is specified, only the |
Sample
In this example, we remove a group with the id 9d3d19df-755d-4bc0–84fe-675d79e8c49a
from the groups of a specific user.
Request
https://example.youtrack.cloud/hub/api/rest/users/7a0563d6-a39e-4724-80e7-081acb8d2c99/groups/9d3d19df-755d-4bc0-84fe-675d79e8c49a