TeamCity REST API Reference
 
2025.03
  1. Autogenerated REST API Reference
  2. Methods
  3. GroupApi

GroupApi

Last modified: 30 March 2022

getAllGroups

Get all user groups.

Endpoint

GET
/app/rest/userGroups

Produces

  • application/xml

  • application/json

Parameters

  • fields: string

Response

Groups

addGroup

Add a new user group.

Endpoint

POST
/app/rest/userGroups

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

  • body: Group

  • fields: string

Response

Group

deleteGroup

Delete user group matching the locator.

Endpoint

DELETE
/app/rest/userGroups/{groupLocator}

Parameters

  • groupLocator: string

getUserGroupOfGroup

Get user group matching the locator.

Endpoint

GET
/app/rest/userGroups/{groupLocator}

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • fields: string

Response

Group

getGroupParentGroups

Get parent groups of the matching user group.

Endpoint

GET
/app/rest/userGroups/{groupLocator}/parent-groups

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • fields: string

Response

Groups

setGroupParentGroups

Update parent groups of the matching user group.

Endpoint

PUT
/app/rest/userGroups/{groupLocator}/parent-groups

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • body: Groups

  • fields: string

Response

Groups

getGroupProperties

Get properties of the matching user group.

Endpoint

GET
/app/rest/userGroups/{groupLocator}/properties

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • fields: string

Response

Properties

removeGroupProperty

Remove a property of the matching user group.

Endpoint

DELETE
/app/rest/userGroups/{groupLocator}/properties/{name}

Parameters

  • groupLocator: string

  • name: string

getGroupProperty

Get a property of the matching user group.

Endpoint

GET
/app/rest/userGroups/{groupLocator}/properties/{name}

Produces

  • text/plain

Parameters

  • groupLocator: string

  • name: string

Response

string

setGroupProperty

Update a property of the matching user group.

Endpoint

PUT
/app/rest/userGroups/{groupLocator}/properties/{name}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

  • groupLocator: string

  • name: string

  • body: string

Response

string

getGroupRoles

Get all roles of the matching user group.

Endpoint

GET
/app/rest/userGroups/{groupLocator}/roles

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

Response

Roles

addRoleToGroup

Add a role to the matching user group.

Endpoint

POST
/app/rest/userGroups/{groupLocator}/roles

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • body: Role

Response

Role

setGroupRoles

Update roles of the matching user group.

Endpoint

PUT
/app/rest/userGroups/{groupLocator}/roles

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • body: Roles

Response

Roles

removeRoleAtScopeFromGroup

Remove a role with the specific scope from the matching user group.

Endpoint

DELETE
/app/rest/userGroups/{groupLocator}/roles/{roleId}/{scope}

Parameters

  • groupLocator: string

  • roleId: string

  • scope: string

getGroupRoleAtScope

Get a role with the specific scope of the matching user group.

Endpoint

GET
/app/rest/userGroups/{groupLocator}/roles/{roleId}/{scope}

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • roleId: string

  • scope: string

Response

Role

addRoleAtScopeToGroup

Add a role with the specific scope to the matching user group.

Endpoint

POST
/app/rest/userGroups/{groupLocator}/roles/{roleId}/{scope}

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • roleId: string

  • scope: string

Response

Role