User Bundles

This resource lets you work with the sets of users in YouTrack.

Resource	/api/admin/customFieldSettings/bundles/user
Returned entity	UserBundle. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of UserBundles. `POST`: Add a New UserBundle.
Supported sub-resources	/api/admin/customFieldSettings/bundles/user/{bundleID}: Operations with Specific UserBundle /api/admin/customFieldSettings/bundles/user/{bundleID}/groups: Groups in the User Bundle /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals: Individual Users in the Bundle /api/admin/customFieldSettings/bundles/user/{bundleID}/aggregatedUsers: Aggregated Users in the Bundle

UserBundle attributes

Represents a set of values that contains users. You can add to the set both individual user accounts and groups of users.

Related Resources

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

User Bundles

Extends Bundle

Attributes

This table describes attributes of the UserBundle 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 set of users. `Read-only`.
groups	Array of UserGroups	User groups that belong to this bundle.
individuals	Array of Users	Individual users that belong to this bundle.
aggregatedUsers	Array of Users	All users that belong to this bundle. `Read-only`.
isUpdateable	Boolean	If `true`, then the currently logged-in user can update this bundle. Otherwise, `false`. `Read-only`.

Read a List of UserBundles

Get the list of all available sets of users in YouTrack.

Request syntax

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

Request parameters

Parameter

Type

Description

fields

String

A list of UserBundle 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?fields=name,id,isUpdateable,individuals(login,id,name),groups(name,id),aggregatedUsers(name,id,login)&$top=2
            

Sample response body

                [
                  {
                    "groups": [
                      {
                        "name": "Sample Project Team",
                        "id": "3-2",
                        "$type": "UserGroup"
                      }
                    ],
                    "aggregatedUsers": [
                      {
                        "login": "root",
                        "name": "John Smith",
                        "id": "1-1",
                        "$type": "User"
                      },
                      {
                        "login": "john.doe",
                        "name": "John Doe",
                        "id": "1-2",
                        "$type": "User"
                      },
                      {
                        "login": "jane.doe",
                        "name": "Jane Doe",
                        "id": "1-3",
                        "$type": "User"
                      }
                    ],
                    "individuals": [],
                    "isUpdateable": true,
                    "name": "Sample Project: Assignees",
                    "id": "8-0",
                    "$type": "UserBundle"
                  },
                  {
                    "groups": [
                      {
                        "name": "Rest Api Project Team",
                        "id": "3-4",
                        "$type": "UserGroup"
                      }
                    ],
                    "aggregatedUsers": [
                      {
                        "login": "john.doe",
                        "name": "John Doe",
                        "id": "1-2",
                        "$type": "User"
                      },
                      {
                        "login": "jane.doe",
                        "name": "Jane Doe",
                        "id": "1-3",
                        "$type": "User"
                      },
                      {
                        "login": "Jane_Smith",
                        "name": "Jane Smith",
                        "id": "1-4",
                        "$type": "User"
                      }
                    ],
                    "individuals": [
                      {
                        "login": "jane.doe",
                        "name": "Jane Doe",
                        "id": "1-3",
                        "$type": "User"
                      },
                      {
                        "login": "Jane_Smith",
                        "name": "Jane Smith",
                        "id": "1-4",
                        "$type": "User"
                      }
                    ],
                    "isUpdateable": true,
                    "name": "Rest Api Project: Assignees",
                    "id": "8-2",
                    "$type": "UserBundle"
                  }
                ]
            

Add a New UserBundle

Create a new set of users.

Required permissions

Requires permissions: Update Project or Low-level Admin Write

Request syntax

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

Request parameters

Parameter	Type	Description
fields	String	A list of UserBundle 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?fields=id,name,aggregatedUsers(id,login)
            

Sample request body

                {
                  "individuals": [
                    {
                      "id": "1-3"
                    },
                    {
                      "id": "1-2"
                    },
                    {
                      "id": "1-4"
                    }
                  ],
                  "name": "Hero-team",
                  "isUpdateable": true
                }
            

Sample response body

                {
                  "aggregatedUsers": [
                    {
                      "login": "john.doe",
                      "id": "1-2",
                      "$type": "User"
                    },
                    {
                      "login": "jane.doe",
                      "id": "1-3",
                      "$type": "User"
                    },
                    {
                      "login": "Jane_Smith",
                      "id": "1-4",
                      "$type": "User"
                    }
                  ],
                  "name": "Hero-team",
                  "id": "8-20",
                  "$type": "UserBundle"
                }
            

Last modified: 7 November 2024