TeamCity REST API Reference
 
2024.07
  1. Autogenerated REST API Reference
  2. Methods
  3. RoleApi

RoleApi

Last modified: 22 May 2023

getRoles

Get all roles.

Endpoint

GET
/app/rest/roles

Produces

  • application/xml

  • application/json

Parameters

  • fields: string

Response

Roles

createRole

Create a new role.

Endpoint

POST
/app/rest/roles

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

  • body: Role

  • fields: string

Response

Role

deleteRole

Delete a role matching the id.

Endpoint

DELETE
/app/rest/roles/id:{id}

Parameters

  • id: string

getRole

Get a role with specified id.

Endpoint

GET
/app/rest/roles/id:{id}

Produces

  • application/xml

  • application/json

Parameters

  • id: string

  • fields: string

Response

Role

removeIncludedRole

Remove an included role.

Endpoint

DELETE
/app/rest/roles/id:{roleId}/included/{includedId}

Produces

  • application/xml

  • application/json

Parameters

  • roleId: string

  • includedId: string

  • fields: string

Response

Role

addIncludedRole

Add an included role.

Endpoint

PUT
/app/rest/roles/id:{roleId}/included/{includedId}

Produces

  • application/xml

  • application/json

Parameters

  • roleId: string

  • includedId: string

  • fields: string

Response

Role

removePermission

Remove a permission from a role.

Endpoint

DELETE
/app/rest/roles/id:{roleId}/permissions/{permissionId}

Produces

  • application/xml

  • application/json

Parameters

  • roleId: string

  • permissionId: string

  • fields: string

Response

Role

addPermission

Add a permission to a role.

Endpoint

PUT
/app/rest/roles/id:{roleId}/permissions/{permissionId}

Produces

  • application/xml

  • application/json

Parameters

  • roleId: string

  • permissionId: string

  • fields: string

Response

Role