TeamCity REST API Reference 2025.11 Help

ServerAuthSettings

Stores settings that manage users accessing the TeamCity server.Use the /app/rest/server/authSettings endpoint to view and edit these settings, or navigate to Admin | Authentication page in TeamCity UI.

Related Help article: Configuring Authentication Settings

Properties

allowGuest

true if users can log into TeamCity as guests; false if only registered users can access TeamCity.

guestUsername

The default username for all users logged in as guests.

welcomeText

The custom text displayed on the TeamCity log in page.

collapseLoginForm

true if the username/password fields on the login page is collapsed by default, promoting authentication via third-party services. false if the username/password fields are initially visible.

perProjectPermissions

true if the per-project authorization mode is enabled; otherwise, false.

emailVerification

true if users must enter their emails on registration; false if they can skip this setting.

buildAuthenticationMode

strict if builds can access only their own projects, projects that own VCS roots, and artifact dependencies projects. lax if builds have elevated permissions to access any project on the server (the default behavior).

modules

Returns currently enabled authentication modules.

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.

<serverAuthSettings allowGuest="false" buildAuthenticationMode="strict" collapseLoginForm="false" emailVerification="false" guestUsername="guest" perProjectPermissions="true" welcomeText="string"> <modules> <module>[[[AuthModule...|authmodule.html]]]</module> </modules> </serverAuthSettings>
{ "emailVerification" : false, "collapseLoginForm" : false, "guestUsername" : "guest", "perProjectPermissions" : true, "welcomeText" : "welcomeText", "allowGuest" : false, "modules" : { "module" : [ { "name" : "name", "properties" : { "count" : 1, "property" : [ { "inherited" : true, "name" : "name", "type" : "[[[type...|type.html]]]", "value" : "value" } ], "href" : "href" } } ] }, "buildAuthenticationMode" : "strict" }
Last modified: 02 December 2025