TeamCity REST API Reference 2025.11 Help

Users

Represents a list of User entities.

Properties

count

The current number of User objects in this collection.

user

The list of User objects in this collection.

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.

<users count="12"> <user>[[[user...|user.html]]]</user> </users>
{ "count" : 12, "user" : [ { "lastLogin" : "20241001T155514+0200", "roles" : { "role" : [ "[[[roleAssignment...|roleassignment.html]]]" ] }, "groups" : { "count" : 2, "group" : [ "[[[group...|group.html]]]" ] }, "hasPassword" : true, "password" : "foobar", "enabled2FA" : false, "name" : "John Doe", "realm" : "realm", "id" : 1, "href" : "/app/rest/users/id:11", "locator" : "null", "email" : "email", "properties" : { "count" : 1, "property" : [ { "inherited" : true, "name" : "name", "type" : "[[[type...|type.html]]]", "value" : "value" } ], "href" : "href" }, "username" : "johndoe", "avatars" : { "urlToSize80" : "/app/rest/avatars/id:1/80/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize28" : "/app/rest/avatars/id:1/28/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize40" : "/app/rest/avatars/id:1/40/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize32" : "/app/rest/avatars/id:1/32/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize20" : "/app/rest/avatars/id:1/20/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize64" : "/app/rest/avatars/id:1/64/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png", "urlToSize56" : "/app/rest/avatars/id:1/56/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png" } } ] }
Last modified: 02 December 2025