YouTrack Server
 
2019.2
Get YouTrack Standalone
You are viewing the documentation for an earlier version of YouTrack Server. View this page in the current documentation
  1. Resources for Developers
  2. REST API
  3. REST API Reference
  4. Resources
  5. User Bundles
  6. Sub-resources
  7. Individual Users in the Bundle

Individual Users in the Bundle

Last modified: 17 December 2019

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.

This table describes attributes of the User entity.

  • To receive an attribute in the response from server, specify it explicitly in the request parameter fields.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

login

String

The login of the user. Read-only. Can be null.

fullName

String

The full name of the user as seen in their profile. Read-only. Can be null.

email

String

The email address of the user. Read-only. Can be null.

jabberAccountName

String

The jabber account name of the user. Read-only. Can be null.

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. Read-only. Can be null.

guest

Boolean

Indicates whether the user is guest. Read-only.

online

Boolean

Indicates whether the user is currently online. Read-only.

banned

Boolean

Indicates whether the user is banned. Read-only.

tags

Array of IssueTags

Tags that belong to this user. Read-only.

savedQueries

Array of SavedQueries

Saved searches that belong to this user. Read-only.

avatarUrl

String

The URL of the user avatar. Read-only.

profiles

GeneralUserProfile |
NotificationsUserProfile |
TimeTrackingUserProfile

List of the user's profiles. Read-only.

Read a List of Users

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

Request syntax 

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

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 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.

Sample

Sample request URI 

https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/bundles/user/8-2/individuals?fields=name,id,login

Sample response body 

[
  {
    "login": "jane.doe",
    "name": "Jane Doe",
    "id": "1-3",
    "$type": "User"
  },
  {
    "login": "Jane_Smith",
    "name": "Jane Smith",
    "id": "1-4",
    "$type": "User"
  }
]

Add a New User

Add an existing user to the bundle.

Required permissions

Requires Project Update 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}/individuals?{fields}

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 entityID is returned

Sample

Sample request URI 

https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/bundles/user/8-2/individuals?fields=name,id,login

Sample request body 

{ "id" : "1-7" }

Sample response body 

{
  "login": "Mad_Max",
  "name": "Mad Max",
  "id": "1-7",
  "$type": "User"
}