AuthModule

Represents a configured authentication module (plugin) on the TeamCity server. Each module corresponds to one enabled authentication method, such as built-in username/password, LDAP, or an external OAuth provider. The properties field contains the module-specific configuration parameters.

Properties

name

The name (type identifier) of this authentication module.

properties

The configuration properties of this authentication module.

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.

<AuthModule name="Default">
  <properties count="3" href="/app/rest/buildTypes/id:MyBuild/parameters">
    <property>[[[property...|property.html]]]</property>
  </properties>
</AuthModule>

{
  "name" : "Default",
  "properties" : {
    "count" : 3,
    "property" : [ {
      "inherited" : false,
      "name" : "my.build.param",
      "type" : "[[[type...|type.html]]]",
      "value" : "production"
    } ],
    "href" : "/app/rest/buildTypes/id:MyBuild/parameters"
  }
}

Last modified: 18 August 2026