YouTrack Standalone 2019.1 Help

User Groups

Resource

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

Returned entity

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

Supported methods

UserGroup attributes

Represents a group of users.

This table describes attributes of the UserGroup 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

name

String

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

ringId

String

ID of the user in Hub. Read-only.

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.

Read a List of UserGroups

Request syntax

GET /api/admin/customFieldSettings/bundles/user/{bundleID}/groups?{fields}&{$top}&{$skip}

Request parameters

Parameter

Type

Description

fields

string

A list of UserGroup 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 UserGroup

Adds an existing group to the bundle.

Request syntax

POST /api/admin/customFieldSettings/bundles/user/{bundleID}/groups?{fields}

Request parameters

Parameter

Type

Description

fields

string

A list of UserGroup attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Last modified: 17 May 2019