TeamCity Users API
Manage users and user groups
TeamCity Users API is one of 17 APIs that TeamCity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a JSON-LD context, and 1 JSON Schema.
This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 2024.12.1.
Requests are made against a single base URL, https://{server}/app/rest.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
TeamCity Users API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
bearerAuth— Bearer token authentication using access tokensbasicAuth— HTTP Basic authentication with username and password
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Manage users and user groups
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are User (8 properties), Group (5 properties), Role (3 properties), Users (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from TeamCity 12
Other APIs TeamCity publishes across the network.