---
schema: rendered-html/v1
title: "User | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/api-entity-User.html
generated_at: 2026-06-11T14:57:19.088188+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Get Started with REST API
- REST API Reference
- Entities
- AccessScope
- ActivityCategory
- ActivityCursorPage
- ActivityItem
- Agile
- AgileColumn
- AgileSharingSettings
- AgileStatus
- AppearanceSettings
- ArticleAttachment
- ArticleComment
- AssignedRole
- BackupError
- BackupFile
- BackupStatus
- BaseArticle
- BaseWorkItem
- Bundle
- BundleElement
- ChangesProcessor
- ColorCoding
- ColumnSettings
- CommandList
- CommandVisibility
- CustomField
- CustomFieldCondition
- CustomFieldDefaults
- DatabaseAttributeValue
- DatabaseBackupSettings
- DateFormatDescriptor
- DuplicateVote
- DurationValue
- EmailSettings
- Event
- ExternalArticle
- ExternalIssue
- FieldStyle
- FieldType
- FilterField
- GeneralUserProfile
- GlobalSettings
- GlobalTimeTrackingSettings
- Issue
- IssueAttachment
- IssueComment
- IssueCountResponse
- IssueCustomField
- IssueFolder
- IssueKey
- IssueLink
- IssueLinkType
- IssueTimeTracking
- IssueVoters
- IssueWatcher
- IssueWatchers
- License
- LocaleDescriptor
- LocaleSettings
- Logo
- NotificationSettings
- NotificationsUserProfile
- OnlineUsers
- Organization
- ParsedCommand
- PeriodFieldFormat
- PeriodValue
- Permission
- ProjectColor
- ProjectCustomField
- ProjectTimeTrackingSettings
- PullRequest
- PullRequestChange
- PullRequestState
- Reaction
- RestCorsSettings
- Role
- SearchSuggestions
- Sprint
- SprintsSettings
- StorageEntry
- Suggestion
- SwimlaneSettings
- SwimlaneValue
- SystemSettings
- TagSharingSettings
- Telemetry
- TextFieldValue
- TimeTrackingUserProfile
- [TimeZoneDescriptor](jetbrains__com__help__youtrack__devportal__api-entity-timezonedescriptor.md)
- [User](api-entity-User.html)
- Me
- VcsUnresolvedUser
- [UserGroup](jetbrains__com__help__youtrack__devportal__api-entity-usergroup.md)
- [UserProfiles](jetbrains__com__help__youtrack__devportal__api-entity-userprofiles.md)
- [UserType](jetbrains__com__help__youtrack__devportal__api-entity-usertype.md)
- [VcsChange](jetbrains__com__help__youtrack__devportal__api-entity-vcschange.md)
- VcsServer
- Visibility
- WIPLimit
- WatchFolderSharingSettings
- WorkItemAttribute
- WorkItemAttributePrototype
- WorkItemAttributeValue
- WorkItemProjectAttribute
- WorkItemType
- WorkTimeSettings
- Resources
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Entities
4. [User](#0)

# User﻿

Last modified: 31 March 2026

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.

- Users
- Individual Users in the Bundle
- Aggregated Users in the Bundle

Extended by:

- VcsUnresolvedUser
- Me

## Attributes﻿

This table describes attributes of the `User` entity.

- To receive an attribute in the response from the server, specify it explicitly in the `fields` request parameter.
- To update an attribute, provide it in the body of a POST request.

| Field | Type | Description |
| id | String | The ID of the user. `Read-only`. |
| 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`. |
| 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`. |
| isAnonymized | Boolean | Indicates whether the user's personal data has been anonymized. `Read-only`. |
| tags | Array of Tags | 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](jetbrains__com__help__youtrack__devportal__api-entity-userprofiles.md) | The profiles of the user. `Read-only`. |
| userType | [UserType](jetbrains__com__help__youtrack__devportal__api-entity-usertype.md) | The type of the user. `Read-only`. |

- [User](/help/youtrack/devportal/api-entity-User.html)
- [Related Resources](/help/youtrack/devportal/api-entity-User.html#z4nibwr_3)
- [Attributes](/help/youtrack/devportal/api-entity-User.html#z4nibwr_6)

[TimeZoneDescriptor](jetbrains__com__help__youtrack__devportal__api-entity-timezonedescriptor.md)Me

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.
