Tenant

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.

Create a Tenant Resource

new Tenant(name: string, args: TenantArgs, opts?: CustomResourceOptions);

def Tenant(resource_name, opts=None, allow_password_signup=None, disable_auth=None, display_name=None, enable_email_link_signin=None, project=None, __props__=None);

func NewTenant(ctx *Context, name string, args TenantArgs, opts ...ResourceOption) (*Tenant, error)

public Tenant(string name, TenantArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args TenantArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TenantArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TenantArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Tenant Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Tenant resource accepts the following input properties:

DisplayName string: Human friendly display name of the tenant.
AllowPasswordSignup bool: Whether to allow email/password user authentication.
DisableAuth bool: 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.
EnableEmailLinkSignin bool: Whether to enable email link user authentication.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

DisplayName string: Human friendly display name of the tenant.
AllowPasswordSignup bool: Whether to allow email/password user authentication.
DisableAuth bool: 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.
EnableEmailLinkSignin bool: Whether to enable email link user authentication.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

displayName string: Human friendly display name of the tenant.
allowPasswordSignup boolean: Whether to allow email/password user authentication.
disableAuth boolean: 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.
enableEmailLinkSignin boolean: Whether to enable email link user authentication.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

display_name str: Human friendly display name of the tenant.
allow_password_signup bool: Whether to allow email/password user authentication.
disable_auth bool: 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.
enable_email_link_signin bool: Whether to enable email link user authentication.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the Tenant resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the tenant that is generated by the server

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the tenant that is generated by the server

id string: The provider-assigned unique ID for this managed resource.
name string: The name of the tenant that is generated by the server

id str: The provider-assigned unique ID for this managed resource.
name str: The name of the tenant that is generated by the server

Look up an Existing Tenant Resource

Get an existing Tenant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TenantState, opts?: CustomResourceOptions): Tenant

static get(resource_name, id, opts=None, allow_password_signup=None, disable_auth=None, display_name=None, enable_email_link_signin=None, name=None, project=None, __props__=None);

func GetTenant(ctx *Context, name string, id IDInput, state *TenantState, opts ...ResourceOption) (*Tenant, error)

public static Tenant Get(string name, Input<string> id, TenantState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllowPasswordSignup bool: Whether to allow email/password user authentication.
DisableAuth bool: 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.
DisplayName string: Human friendly display name of the tenant.
EnableEmailLinkSignin bool: Whether to enable email link user authentication.
Name string: The name of the tenant that is generated by the server
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

AllowPasswordSignup bool: Whether to allow email/password user authentication.
DisableAuth bool: 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.
DisplayName string: Human friendly display name of the tenant.
EnableEmailLinkSignin bool: Whether to enable email link user authentication.
Name string: The name of the tenant that is generated by the server
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

allowPasswordSignup boolean: Whether to allow email/password user authentication.
disableAuth boolean: 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.
displayName string: Human friendly display name of the tenant.
enableEmailLinkSignin boolean: Whether to enable email link user authentication.
name string: The name of the tenant that is generated by the server
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

allow_password_signup bool: Whether to allow email/password user authentication.
disable_auth bool: 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.
display_name str: Human friendly display name of the tenant.
enable_email_link_signin bool: Whether to enable email link user authentication.
name str: The name of the tenant that is generated by the server
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud