Operations with Specific User
This resource lets you work with user settings in YouTrack.
warning
Please note that this resource lets you manage only the YouTrack's profile of the user account. Any operation that relates to the authorization or access management must be performed with the Hub REST API. That is, for operations like create a new user, update user credentials, grant or revoke roles and permissions, and so on, you must use respective Hub REST API endpoints.
Resource | |
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.
Related Resources
Below you can find the list of resources that let you work with this entity.
Attributes
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 | Array of Tags | Tags that belong to this user. |
savedQueries | Array of SavedQueries | Saved searches that belong to this user. |
avatarUrl | String | The URL of the user avatar. |
profiles | UserProfiles | The profiles of the user. |
Read a Specific User
Read settings of the YouTrack profile of the specific user.
Requires permissions: Read User Basic
Required permissions
No permissions are required for reading basic information, for accessing all data requires Read User permission.
Request syntax
GET /api/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 |
Sample 1
This sample shows GET request from a user with restricted permissions.
Sample request
https://example.youtrack.cloud/api/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
https://example.youtrack.cloud/api/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": "Tag"
},
{
"issues": [],
"name": "Nice task",
"id": "6-9",
"$type": "Tag"
},
{
"issues": [],
"name": "Dangerous",
"id": "6-10",
"$type": "Tag"
}
],
"online": false,
"guest": false,
"login": "jane.doe",
"banned": false,
"name": "Jane Doe",
"$type": "User"
}Sample 3
You can also use the login of the user instead of the database ID in a request URI. This sample shows how to read a user by their login.
Sample request
https://example.youtrack.cloud/api/users/john.smith?fields=name,login,banned,email,guest,onlineSample response body
{
"login": "john.smith",
"guest": false,
"banned": false,
"email": "john.smith@example.com",
"online": false,
"name": "John Smith",
"$type": "User"
}