Developer Portal for YouTrack and Hub 2021.4 Help

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/{userID}

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.

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.

fullName

String

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

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

UserProfiles

The profiles of the user. Read-only.

Read a Specific User

Get specified user from the bundle.

Required permissions

Requires read access to the bundle.

Request syntax

GET /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}?{fields}

{userID}

Database ID of the user.

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

https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-2/individuals/1-4?fields=name,id,login,guest,banned,online,email,ringId

Sample response body

{ "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" }

Delete a Specific User

Remove specified user from 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

DELETE /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}

{userID}

Database ID of the user.

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

https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-2/individuals/1-7
Last modified: 17 November 2021