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

Example Usage - Identity Platform Tenant Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var tenant = new Gcp.IdentityPlatform.Tenant("tenant", new Gcp.IdentityPlatform.TenantArgs
    {
        AllowPasswordSignup = true,
        DisplayName = "tenant",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Tenant

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.IdentityPlatform

Assembly: Pulumi.Gcp.dll

Syntax

public class Tenant : CustomResource

Constructors

Tenant(String, TenantArgs, CustomResourceOptions)

Create a Tenant resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
TenantArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AllowPasswordSignup

Whether to allow email/password user authentication.

Declaration

public Output<bool?> AllowPasswordSignup { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

DisableAuth

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.

Declaration

public Output<bool?> DisableAuth { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

DisplayName

Human friendly display name of the tenant.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

EnableEmailLinkSignin

Whether to enable email link user authentication.

Declaration

public Output<bool?> EnableEmailLinkSignin { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Name

The name of the tenant that is generated by the server

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, TenantState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
TenantState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Tenant