# AuthSettings

> Resource AuthSettings in pulumi-teamcity.

<!-- Generated from the pulumi-teamcity SDK. -->

Resource AuthSettings in pulumi-teamcity.

Pulumi type: `teamcity:index/authSettings:AuthSettings`.

`name` is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as teamcity from "pulumi-teamcity"

const resource = new teamcity.AuthSettings("authSettings", {
  allowGuest: true,
  collapseLoginForm: true,
  emailVerification: true,
  guestUsername: "<guestUsername>",
  modules: {
    token: {},
  },
  perProjectPermissions: true,
  welcomeText: "<welcomeText>",
})
```

## Arguments

| Property                | Type                          | Required | Description |
| ----------------------- | ----------------------------- | -------- | ----------- |
| `allowGuest`            | `boolean`                     | yes      |             |
| `collapseLoginForm`     | `boolean`                     | yes      |             |
| `emailVerification`     | `boolean`                     | yes      |             |
| `guestUsername`         | `string`                      | yes      |             |
| `modules`               | `AuthSettingsModules (input)` | yes      |             |
| `perProjectPermissions` | `boolean`                     | yes      |             |
| `welcomeText`           | `string`                      | yes      |             |

## Outputs

Computed outputs are produced by the provider. They are not constructor arguments.

| Property                | Type                           | Computed | Description |
| ----------------------- | ------------------------------ | -------- | ----------- |
| `allowGuest`            | `boolean`                      | no       |             |
| `collapseLoginForm`     | `boolean`                      | no       |             |
| `emailVerification`     | `boolean`                      | no       |             |
| `guestUsername`         | `string`                       | no       |             |
| `modules`               | `AuthSettingsModules (output)` | no       |             |
| `perProjectPermissions` | `boolean`                      | no       |             |
| `welcomeText`           | `string`                       | no       |             |

## `AuthSettingsModules (input)`

Input object `AuthSettingsModules`. Fields below belong to this object, not to the parent.

| Property           | Type                                          | Required | Description |
| ------------------ | --------------------------------------------- | -------- | ----------- |
| `basicHttp`        | `AuthSettingsModulesBasicHttp (input)`        | no       |             |
| `builtIn`          | `AuthSettingsModulesBuiltIn (input)`          | no       |             |
| `github`           | `AuthSettingsModulesGithub (input)`           | no       |             |
| `githubApp`        | `AuthSettingsModulesGithubApp (input)`        | no       |             |
| `githubEnterprise` | `AuthSettingsModulesGithubEnterprise (input)` | no       |             |
| `google`           | `AuthSettingsModulesGoogle (input)`           | no       |             |
| `jetbrainsSpace`   | `AuthSettingsModulesJetbrainsSpace (input)`   | no       |             |
| `ldap`             | `AuthSettingsModulesLdap (input)`             | no       |             |
| `token`            | `AuthSettingsModulesToken (input)`            | yes      |             |

## `AuthSettingsModulesBasicHttp (input)`

Input object `AuthSettingsModulesBasicHttp`. Fields below belong to this object, not to the parent.

This object has no fields.

## `AuthSettingsModulesBuiltIn (input)`

Input object `AuthSettingsModulesBuiltIn`. Fields below belong to this object, not to the parent.

| Property          | Type      | Required | Description |
| ----------------- | --------- | -------- | ----------- |
| `changePasswords` | `boolean` | yes      |             |
| `registration`    | `boolean` | yes      |             |
| `resetPasswords`  | `boolean` | no       |             |

## `AuthSettingsModulesGithub (input)`

Input object `AuthSettingsModulesGithub`. Fields below belong to this object, not to the parent.

| Property         | Type      | Required | Description |
| ---------------- | --------- | -------- | ----------- |
| `createNewUsers` | `boolean` | yes      |             |
| `organizations`  | `string`  | yes      |             |

## `AuthSettingsModulesGithubApp (input)`

Input object `AuthSettingsModulesGithubApp`. Fields below belong to this object, not to the parent.

| Property         | Type      | Required | Description |
| ---------------- | --------- | -------- | ----------- |
| `createNewUsers` | `boolean` | yes      |             |
| `organizations`  | `string`  | yes      |             |

## `AuthSettingsModulesGithubEnterprise (input)`

Input object `AuthSettingsModulesGithubEnterprise`. Fields below belong to this object, not to the parent.

| Property         | Type      | Required | Description |
| ---------------- | --------- | -------- | ----------- |
| `createNewUsers` | `boolean` | yes      |             |
| `organizations`  | `string`  | yes      |             |

## `AuthSettingsModulesGoogle (input)`

Input object `AuthSettingsModulesGoogle`. Fields below belong to this object, not to the parent.

| Property         | Type      | Required | Description |
| ---------------- | --------- | -------- | ----------- |
| `allDomains`     | `boolean` | yes      |             |
| `createNewUsers` | `boolean` | yes      |             |
| `domains`        | `string`  | no       |             |

## `AuthSettingsModulesJetbrainsSpace (input)`

Input object `AuthSettingsModulesJetbrainsSpace`. Fields below belong to this object, not to the parent.

| Property         | Type      | Required | Description |
| ---------------- | --------- | -------- | ----------- |
| `createNewUsers` | `boolean` | yes      |             |

## `AuthSettingsModulesLdap (input)`

Input object `AuthSettingsModulesLdap`. Fields below belong to this object, not to the parent.

| Property         | Type      | Required | Description |
| ---------------- | --------- | -------- | ----------- |
| `createNewUsers` | `boolean` | yes      |             |

## `AuthSettingsModulesToken (input)`

Input object `AuthSettingsModulesToken`. Fields below belong to this object, not to the parent.

This object has no fields.

## `AuthSettingsModules (output)`

Output object `AuthSettingsModules`. Fields below belong to this object.

| Property           | Type                                           | Always present | Description |
| ------------------ | ---------------------------------------------- | -------------- | ----------- |
| `basicHttp`        | `AuthSettingsModulesBasicHttp (output)`        | no             |             |
| `builtIn`          | `AuthSettingsModulesBuiltIn (output)`          | no             |             |
| `github`           | `AuthSettingsModulesGithub (output)`           | no             |             |
| `githubApp`        | `AuthSettingsModulesGithubApp (output)`        | no             |             |
| `githubEnterprise` | `AuthSettingsModulesGithubEnterprise (output)` | no             |             |
| `google`           | `AuthSettingsModulesGoogle (output)`           | no             |             |
| `jetbrainsSpace`   | `AuthSettingsModulesJetbrainsSpace (output)`   | no             |             |
| `ldap`             | `AuthSettingsModulesLdap (output)`             | no             |             |
| `token`            | `AuthSettingsModulesToken (output)`            | yes            |             |

## `AuthSettingsModulesBasicHttp (output)`

Output object `AuthSettingsModulesBasicHttp`. Fields below belong to this object.

This object has no fields.

## `AuthSettingsModulesBuiltIn (output)`

Output object `AuthSettingsModulesBuiltIn`. Fields below belong to this object.

| Property          | Type      | Always present | Description |
| ----------------- | --------- | -------------- | ----------- |
| `changePasswords` | `boolean` | yes            |             |
| `registration`    | `boolean` | yes            |             |
| `resetPasswords`  | `boolean` | no             |             |

## `AuthSettingsModulesGithub (output)`

Output object `AuthSettingsModulesGithub`. Fields below belong to this object.

| Property         | Type      | Always present | Description |
| ---------------- | --------- | -------------- | ----------- |
| `createNewUsers` | `boolean` | yes            |             |
| `organizations`  | `string`  | yes            |             |

## `AuthSettingsModulesGithubApp (output)`

Output object `AuthSettingsModulesGithubApp`. Fields below belong to this object.

| Property         | Type      | Always present | Description |
| ---------------- | --------- | -------------- | ----------- |
| `createNewUsers` | `boolean` | yes            |             |
| `organizations`  | `string`  | yes            |             |

## `AuthSettingsModulesGithubEnterprise (output)`

Output object `AuthSettingsModulesGithubEnterprise`. Fields below belong to this object.

| Property         | Type      | Always present | Description |
| ---------------- | --------- | -------------- | ----------- |
| `createNewUsers` | `boolean` | yes            |             |
| `organizations`  | `string`  | yes            |             |

## `AuthSettingsModulesGoogle (output)`

Output object `AuthSettingsModulesGoogle`. Fields below belong to this object.

| Property         | Type      | Always present | Description |
| ---------------- | --------- | -------------- | ----------- |
| `allDomains`     | `boolean` | yes            |             |
| `createNewUsers` | `boolean` | yes            |             |
| `domains`        | `string`  | no             |             |

## `AuthSettingsModulesJetbrainsSpace (output)`

Output object `AuthSettingsModulesJetbrainsSpace`. Fields below belong to this object.

| Property         | Type      | Always present | Description |
| ---------------- | --------- | -------------- | ----------- |
| `createNewUsers` | `boolean` | yes            |             |

## `AuthSettingsModulesLdap (output)`

Output object `AuthSettingsModulesLdap`. Fields below belong to this object.

| Property         | Type      | Always present | Description |
| ---------------- | --------- | -------------- | ----------- |
| `createNewUsers` | `boolean` | yes            |             |

## `AuthSettingsModulesToken (output)`

Output object `AuthSettingsModulesToken`. Fields below belong to this object.

This object has no fields.