TeamCity REST API Reference 2024.07 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.

Properties

Dimension

Data type

Format

Description

$singleValue

string

String value

Username or 'current' for current user.

affectedGroup

string

UserGroupLocator

User group (direct or indirect parent) locator, includes the user considering group hierarchy.

count

long

int64

For paginated calls, how many entities to return per page.

email

string

String value

User email.

group

string

UserGroupLocator

User group (direct parent) locator, includes the user directly.

id

long

int64

User id.

lastLogin

DateTime

date-time

User's last login time formatted as 'yyyyMMddTHHmmss+ZZZZ'

name

string

ValueCondition

User's display name

property

string

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

Supported matchType values:

  • exists

  • not-exists

  • equals

  • does-not-equal

  • starts-with

  • contains

  • does-not-contain

  • ends-with

  • any

  • matches

  • does-not-match

  • more-than

  • no-more-than

  • less-than

  • no-less-than

  • ver-more-than

  • ver-no-more-than

  • ver-less-than

  • ver-no-less-than

role

string

RoleLocator

User's role

start

long

int64

For paginated calls, from which entity to start rendering the page.

username

string

String value

Username of a user.

Last modified: 04 July 2024