Groups in the User Bundle
This resource lets you work with the user groups that are added to the specific set of users.
Resource | |
Returned entity | UserGroup. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
UserGroup attributes
Represents a group of users.
This table describes attributes of the UserGroup entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
name | String | The name of the group. |
ringId | String | ID of the group in Hub. Use this ID for operations in Hub, and for matching groups between YouTrack and Hub. |
usersCount | Long | The number of users in the group. |
icon | String | The URL of the group icon. |
allUsersGroup | Boolean | True if this group contains all users, otherwise false. |
teamForProject | Project | Project that has this group set as a team. Returns |
Read a Specific UserGroup
Get specified user group that belongs to the user bundle.
Required permissions
Requires read access to the bundle.
Request syntax
GET /api/admin/customFieldSettings/bundles/user/{bundleID}/groups/{groupID}?{fields}{groupID} | Database ID of the user group. |
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 |
Sample
Sample request URI
https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/bundles/user/8-2/groups/3-5?fields=name,id,usersCount,icon,allUsersGroup,teamForProject(name)Sample response body
{
"icon": null,
"allUsersGroup": false,
"teamForProject": {
"name": "Sandbox",
"$type": "Project"
},
"name": "Sandbox Team",
"usersCount": 3,
"id": "3-5",
"$type": "UserGroup"
}Delete a Specific UserGroup
Removes specified group from the bundle.
Required permissions
Requires Project Update permission in all projects where the bundle is used. If the bundle is not used in any field, Update Project permission is required in at least one project.
Request syntax
DELETE /api/admin/customFieldSettings/bundles/user/{bundleID}/groups/{groupID}{groupID} | Database ID of the user group. |
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 |