TeamCity REST API Reference
 
2023.05
You are viewing the documentation for an earlier version of TeamCity REST API Reference.
  1. Autogenerated REST API Reference
  2. Models
  3. User
  4. User

User

Last modified: 22 May 2023

Represents a user.

Related Help article: User Account

Properties

Field

Data type

username

string

name

string

id

long

email

string

lastLogin

string

password

string

hasPassword

boolean

realm

string

href

string

properties

Properties

roles

Roles

groups

Groups

locator

string

avatars

UserAvatars

enabled2FA

boolean

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.

<user email="string" enabled2FA="true" hasPassword="true" href="string" id="123456789" lastLogin="string" locator="string" name="string" password="string" realm="string" username="string">
  <properties count="123" href="string">
    <property>property...</property>
  </properties>
  <roles>
    <role>role...</role>
  </roles>
  <groups count="123">
    <group>group...</group>
  </groups>
  <avatars urlToSize20="string" urlToSize28="string" urlToSize32="string" urlToSize40="string" urlToSize56="string" urlToSize64="string" urlToSize80="string"/>
</user>