TeamCity REST API Reference 2026.2 Help

RoleLocator

Represents a locator string for filtering Role entities. Examples:

  • scope:global,role:SYSTEM_ADMIN — match users with System Administrator role globally.

  • item:(scope:project:<projectLocator>,role:DEVELOPER),method:effective — match users with Developer role in project found by projectLocator, considering group inheritance.

Properties

Dimension

Data type

Format

Description

item

string

AssignmentDimensions

Role assignment locator.

method

string

Matching method: 'effective' (default, considers group and role inheritance) or 'byPermission'.

Supported values:

  • effective

  • byPermission

Last modified: 18 August 2026