Aggregated Users in the Bundle
This resource lets you read the list of all users that the specific bundle contains, both that were added as members of groups and individually.
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.
Aggregated Users in the Bundle
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 the list of all users that the user bundle contains.
GET /api/admin/customFieldSettings/bundles/user/{bundleID}/aggregatedUsers?{fields}&{$top}&{$skip}null | Database ID of 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 |
$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. |
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-20/aggregatedUsers?fields=name,id[
{
"name": "John Smith",
"id": "1-1",
"$type": "User"
},
{
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
{
"name": "Jane Doe",
"id": "1-3",
"$type": "User"
},
{
"name": "Jane Smith",
"id": "1-4",
"$type": "User"
}
]