Individual Users in the Bundle
This resource lets you work with the user accounts that were added individually to a specific set of users (user bundle).
Resource | /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals |
Returned entity | User. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
User attributes
Represents a user in YouTrack. Please note that the read-only properties of a user account, like credentials, or email and so on, you can only change in Hub REST API.
Related Resources
Below you can find the list of resources that let you work with this entity.
Attributes
This table describes attributes of the User
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. |
login | String | The login of the user. |
fullName | String | The full name of the user as seen in their profile. |
String | The email address of the user. | |
ringId | String | ID of the user in Hub. You can use this ID for operations in Hub, and for matching users between YouTrack and Hub. |
guest | Boolean | Indicates whether the user is |
online | Boolean | Indicates whether the user is currently online. |
banned | Boolean | Indicates whether the user is banned. |
tags | Array of Tags | Tags that belong to this user. |
savedQueries | Array of SavedQueries | Saved searches that belong to this user. |
avatarUrl | String | The URL of the user avatar. |
profiles | UserProfiles | The profiles of the user. |
Read a List of Users
Get the list of all individual user accounts that are added to specific user bundle.
Request syntax
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 |
$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
Sample response body
Add a New User
Add an existing user to the bundle.
Required fields: the id
of the user 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
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 |