Developer Portal for YouTrack and Hub Help

UserGroup

Represents a group of users.

Related Resources

Below you can find the list of resources that let you work with this entity.

Attributes

This table describes attributes of the UserGroup 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 group. Read-only.

name

String

The name of the group. Read-only. Can be null.

ringId

String

ID of the group in Hub. Use this ID for operations in Hub, and for matching groups between YouTrack and Hub. Read-only. Can be null.

usersCount

Long

The number of users in the group. Read-only.

icon

String

The URL of the group icon. Read-only. Can be null.

allUsersGroup

Boolean

True if this group contains all users, otherwise false. Read-only.

teamForProject

Project

Project that has this group set as a team. Returns null, if there is no such project. Read-only. Can be null.

Last modified: 7 November 2024