YouTrack InCloud 2019.2 Help

Operations with Specific User

This resource lets you work with user settings in YouTrack.

Resource

/api/admin/users/{userID}

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 Specific User

Read settings of the YouTrack profile of the specific user.

Requires permissions: Read User Basic.

Request syntax

GET /api/admin/users/{userID}?{fields}

{userID}

Database ID of the user in YouTrack.

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 1

This sample shows GET request from a user with restricted permissions.

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/users/1-3?fields=name,login,banned,email,guest,online,tags(id,name,issues(idReadable)),savedQueries(name,issues(idReadable))

Sample response body

{ "savedQueries": [], "tags": [], "online": false, "login": "jane.doe", "banned": false, "name": "Jane Doe", "$type": "User" }

Sample 2

This sample shows the same request but executed by a user with admin permissions.

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/users/1-3?fields=name,login,banned,email,guest,online,tags(id,name,issues(idReadable)),savedQueries(name,issues(idReadable))

Sample response body

{ "savedQueries": [], "email": "jane.doe@example.com", "tags": [ { "issues": [ { "idReadable": "SP-32", "$type": "Issue" } ], "name": "Star", "id": "6-0", "$type": "IssueTag" }, { "issues": [], "name": "Nice task", "id": "6-9", "$type": "IssueTag" }, { "issues": [], "name": "Dangerous", "id": "6-10", "$type": "IssueTag" } ], "online": false, "guest": false, "login": "jane.doe", "banned": false, "name": "Jane Doe", "$type": "User" }
Last modified: 17 October 2019