Groups in the User Bundle

This resource lets you work with the user groups that are added to the specific set of users.

Resource	/api/admin/customFieldSettings/bundles/user/{bundleID}/groups
Returned entity	UserGroup. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Groups in the User Bundle. `POST`: Groups in the User Bundle.

UserGroup attributes

Represents a group of users.

Related Resources

Below you can find the list of resources that let you work with this entity.

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 ID of the user group. `Read-only`.
name	String	The name of the group. `Read-only`. `Can be null`.
ringId	String	ID of the group in Hub. Use this ID for operations in Hub, and for matching groups between YouTrack and Hub. `Read-only`. `Can be null`.
usersCount	Long	The number of users in the group. `Read-only`.
icon	String	The URL of the group icon. `Read-only`. `Can be null`.
allUsersGroup	Boolean	True if this group contains all users, otherwise false. `Read-only`.
teamForProject	Project	Project that has this group set as a team. Returns `null`, if there is no such project. `Read-only`. `Can be null`.

Read a List of UserGroups

Get the list of all groups that are added to specific user bundle.

Request syntax

            GET /api/admin/customFieldSettings/bundles/user/{bundleID}/groups?{fields}&{$top}&{$skip}
        

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.

$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 entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries.

The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination.

Sample

Sample request

                https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-2/groups?fields=name,id,usersCount,icon,allUsersGroup,teamForProject(name)
            

Sample response body

                [
                  {
                    "icon": null,
                    "allUsersGroup": false,
                    "teamForProject": {
                      "name": "Rest Api Project",
                      "$type": "Project"
                    },
                    "name": "Rest Api Project Team",
                    "usersCount": 3,
                    "id": "3-4",
                    "$type": "UserGroup"
                  },
                  {
                    "icon": null,
                    "allUsersGroup": false,
                    "teamForProject": {
                      "name": "Sandbox",
                      "$type": "Project"
                    },
                    "name": "Sandbox Team",
                    "usersCount": 3,
                    "id": "3-5",
                    "$type": "UserGroup"
                  }
                ]
            

Add a New UserGroup

Add an existing group to the bundle.

Required fields: the id of the group you want to add to the bundle.

Required permissions

Requires Update Project 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

POST /api/admin/customFieldSettings/bundles/user/{bundleID}/groups?{fields}

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

Sample request

                https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-2/groups?fields=name,id,usersCount,icon,allUsersGroup,teamForProject(name)
            

Sample request body

{ "id" : "3-5" }

Sample response body

                {
                  "icon": null,
                  "allUsersGroup": false,
                  "teamForProject": {
                    "name": "Sandbox",
                    "$type": "Project"
                  },
                  "name": "Sandbox Team",
                  "usersCount": 3,
                  "id": "3-5",
                  "$type": "UserGroup"
                }
            

Last modified: 7 November 2024