TeamCity REST API Reference 2025.11 Help

RoleAssignment

The object that defines a project scope for a role assigned to a user or a user group. Objects of this class should not be created manually; TeamCity returns one when you retrieve a list of user permissions via the /app/rest/users/{userLocator}/roles endpoint.`

Related Help article: Managing Roles and Permissions

Properties

roleId

The ID of a role assigned to the current user or user group.

scope

The project scope defining where the assigned role applies. Returns g (for global) for roles that have no project scope by desgin (for example, the SYSTEM_ADMIN role), and 'p:' for project-specific roles.

href

The relative (without the TeamCity server URL) link to this role assignment.

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.

<roleAssignment href="/app/rest/users/id:101/roles/AGENT_MANAGER/p:_Root" roleId="AGENT_MANAGER" scope="p:_Root"/>
{ "roleId" : "AGENT_MANAGER", "scope" : "p:_Root", "href" : "/app/rest/users/id:101/roles/AGENT_MANAGER/p:_Root" }
Last modified: 02 December 2025