YouTrack InCloud 2019.2 Help

Operations with Specific UserGroup

This resource lets you work with the user groups that are added to the specific set of users.

Resource

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

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 group 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 Specific UserGroup

Get specified user group that belongs to the user bundle.

Request syntax

GET /api/admin/customFieldSettings/bundles/user/{bundleID}/groups/{groupID}?{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

Delete a Specific UserGroup

Removes specified group from the bundle.

Request syntax

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

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: 20 August 2019