Operations with Specific 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 | |
|---|---|
Returned entity | User. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
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.
Below you can find the list of resources that let you work with this entity.
This table describes attributes of the User entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest 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 | Tags that belong to this user. | |
savedQueries | Saved searches that belong to this user. | |
avatarUrl | String | The URL of the user avatar. |
profiles | The profiles of the user. |
Get specified user from the bundle.
Requires read access to the bundle.
GET /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}?{fields}{userID} | Database ID of the user. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of User attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-2/individuals/1-4?fields=name,id,login,guest,banned,online,email,ringId{
"email": "jane.smith@example.com",
"online": false,
"ringId": "64cb04d0-f691-4386-900d-39f4c98972f9",
"guest": false,
"login": "Jane_Smith",
"banned": false,
"name": "Jane Smith",
"id": "1-4",
"$type": "User"
}Remove specified user from the bundle.
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.
DELETE /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}{userID} | Database ID of the user. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of User attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-2/individuals/1-7