YouTrack Standalone 2019.1 Help

Users

Resource

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

Returned entity

User. For the description of the entity attributes, see Supported Fields section.

Supported methods

Supported sub-resources

  • /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID} Operations with users

  • /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/tags Operations with issue tags

  • /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/savedQueries Operations with saved queries

  • /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/profiles/general Operations with general user profiles

  • /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/profiles/notifications Operations with notifications user profiles

  • /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/profiles/general/timetracking Operations with time tracking user profiles

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

TODO provide documentation for type

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

Read a List of Users

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.

Add a New User

Adds existing user to the bundle.

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.

Last modified: 17 May 2019