TeamCity REST API 2020.2 Help

UserLocator

Represents a locator string for filtering User entities. Examples:

  • name:John Smith – find user with name John Smith.

  • group:<groupLocator> – find all users in user group found by groupLocator.

Dimension Data type Format Description

affectedGroup

string

UserGroupLocator

User group (direct or indirect parent) locator.

email

string

group

string

UserGroupLocator

User group (direct parent) locator.

id

string

item

string

item:(<locator1>),item:(<locator2>...)

Supply multiple locators and return a union of the results.

lastLogin

DateTime

date-time

name

string

property

string

property:(name:<name>,value:<value>,matchType:<matchType>)

Supported matchType values:

  • generic: exists/not-exists/equals/does-not-equal/starts-with/contains/does-not-contain/ends-with/any;

  • regular expressions: matches/does-not-match;

  • numeric: more-than/no-more-than/less-than/no-less-than;

  • version-specific: ver-more-than/ver-no-more-than/ver-less-than/ver-no-less-than.

role

string

RoleLocator

Role locator.

username

string

Last modified: 22 December 2020