v5.18.0/website/docs/r/identity_platform_tenant.html.markdown

---
# ----------------------------------------------------------------------------
#
#     ***     AUTO GENERATED CODE    ***    Type: MMv1     ***
#
# ----------------------------------------------------------------------------
#
#     This file is automatically generated by Magic Modules and manual
#     changes will be clobbered when the file is regenerated.
#
#     Please read more about how to change this file in
#     .github/CONTRIBUTING.md.
#
# ----------------------------------------------------------------------------
subcategory: "Identity Platform"
description: |-
  Tenant configuration in a multi-tenant project.
---

# google\_identity\_platform\_tenant

Tenant configuration in a multi-tenant project.

You must enable the
[Google Identity Platform](https://console.cloud.google.com/marketplace/details/google-cloud-platform/customer-identity) in
the marketplace prior to using this resource.

You must [enable multi-tenancy](https://cloud.google.com/identity-platform/docs/multi-tenancy-quickstart) via
the Cloud Console prior to creating tenants.



<div class = "oics-button" style="float: right; margin: 0 0 -15px">
  <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=identity_platform_tenant_basic&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
  </a>
</div>
## Example Usage - Identity Platform Tenant Basic


```hcl
resource "google_identity_platform_tenant" "tenant" {
  display_name          = "tenant"
  allow_password_signup = true
}
```

## Argument Reference

The following arguments are supported:


* `display_name` -
  (Required)
  Human friendly display name of the tenant.


- - -


* `allow_password_signup` -
  (Optional)
  Whether to allow email/password user authentication.

* `enable_email_link_signin` -
  (Optional)
  Whether to enable email link user authentication.

* `disable_auth` -
  (Optional)
  Whether authentication is disabled for the tenant. If true, the users under
  the disabled tenant are not allowed to sign-in. Admins of the disabled tenant
  are not able to manage its users.

* `project` - (Optional) The ID of the project in which the resource belongs.
    If it is not provided, the provider project is used.


## Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

* `id` - an identifier for the resource with format `projects/{{project}}/tenants/{{name}}`

* `name` -
  The name of the tenant that is generated by the server


## Timeouts

This resource provides the following
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:

- `create` - Default is 20 minutes.
- `update` - Default is 20 minutes.
- `delete` - Default is 20 minutes.

## Import


Tenant can be imported using any of these accepted formats:

* `projects/{{project}}/tenants/{{name}}`
* `{{project}}/{{name}}`
* `{{name}}`


In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Tenant using one of the formats above. For example:

```tf
import {
  id = "projects/{{project}}/tenants/{{name}}"
  to = google_identity_platform_tenant.default
}
```

When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Tenant can be imported using one of the formats above. For example:

```
$ terraform import google_identity_platform_tenant.default projects/{{project}}/tenants/{{name}}
$ terraform import google_identity_platform_tenant.default {{project}}/{{name}}
$ terraform import google_identity_platform_tenant.default {{name}}
```

## User Project Overrides

This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override).