TeamCity REST API Reference 2021.2 Help

GroupApi

getAllGroups

Get all user groups.

Endpoint

/app/rest/userGroups

HTTP method

GET

Produces

  • application/xml

  • application/json

Parameters

  • fields: string

Response

Groups

addGroup

Add a new user group.

Endpoint

/app/rest/userGroups

HTTP method

POST

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

/app/rest/userGroups/{groupLocator}

HTTP method

DELETE

Parameters

  • groupLocator: string

getUserGroupOfGroup

Get user group matching the locator.

Endpoint

/app/rest/userGroups/{groupLocator}

HTTP method

GET

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • fields: string

Response

Group

getGroupParentGroups

Get parent groups of the matching user group.

Endpoint

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

HTTP method

GET

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • fields: string

Response

Groups

setGroupParentGroups

Update parent groups of the matching user group.

Endpoint

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

HTTP method

PUT

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

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

HTTP method

GET

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • fields: string

Response

Properties

removeGroupProperty

Remove a property of the matching user group.

Endpoint

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

HTTP method

DELETE

Parameters

  • groupLocator: string

  • name: string

getGroupProperty

Get a property of the matching user group.

Endpoint

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

HTTP method

GET

Produces

  • text/plain

Parameters

  • groupLocator: string

  • name: string

Response

string

setGroupProperty

Update a property of the matching user group.

Endpoint

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

HTTP method

PUT

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

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

HTTP method

GET

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

Response

Roles

addRoleToGroup

Add a role to the matching user group.

Endpoint

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

HTTP method

POST

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

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

HTTP method

PUT

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

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

HTTP method

DELETE

Parameters

  • groupLocator: string

  • roleId: string

  • scope: string

getGroupRoleAtScope

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

Endpoint

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

HTTP method

GET

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

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

HTTP method

POST

Produces

  • application/xml

  • application/json

Parameters

  • groupLocator: string

  • roleId: string

  • scope: string

Response

Role

Last modified: 21 October 2021