TeamCity REST API Reference 2025.11 Help

Roles

Represents a list of roles.

Related Help article: Managing Roles and Permissions

Properties

Field

Data type

count

integer

role

List<Role>

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.

<roles count="123"> <role>[[[role...|role.html]]]</role> </roles>
{ "role" : [ { "permissions" : "[[[Permissions...|permissions.html]]]", "name" : "name", "id" : "id", "href" : "href", "included" : "[[[roles...|]]]" } ], "count" : 7 }
Last modified: 02 December 2025