Group
A TeamCity user group that unites multiple TeamCity users with identical permissions.
Related Help article: User Group
Properties
key
The group key that serves as a unique group identifier. In TeamCity REST API, group keys are used as the default group dimension, meaning you can omit the key: in path locators (for example, /app/rest/userGroups/ALL_USERS_GROUP).
name
The public group name displayed in TeamCity UI.
href
The relative (without the TeamCity server URL) link to this group.
description
The public user group description.
parent-groups
The list of parent user groups for this group. A user group inherits all roles and notification rules from its parent.
child-groups
The list of child user groups that inherit all roles and notification rules from this group. There is no API to set a list of child groups directly. Instead, edit required groups' parent-groups property via the setGroupParentGroups method.
users
The list of TeamCity users that belong to this group.
roles
The list of roles directly assigned to this group. If this group has parent groups, it inherits their roles but does not include them in this roles list.
properties
The list of additional group properties.
Schema
Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.
A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.