Skip to content

googleIdentityPlatformTenant

Tenant configuration in a multi-tenant project.

You must enable the Google Identity Platform in the marketplace prior to using this resource.

You must enable multi-tenancy via the Cloud Console prior to creating tenants.

Open in Cloud Shell

Example Usage - Identity Platform Tenant Basic

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.identityPlatformTenant.IdentityPlatformTenant(this, "tenant", {
  allow_password_signup: true,
  display_name: "tenant",
});

Argument Reference

The following arguments are supported:

  • displayName - (Required) Human friendly display name of the tenant.

  • allowPasswordSignup - (Optional) Whether to allow email/password user authentication.

  • enableEmailLinkSignin - (Optional) Whether to enable email link user authentication.

  • disableAuth - (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 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:

$ 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.