Tenant class

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

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const tenant = new gcp.identityplatform.Tenant("tenant", {
    displayName: "tenant",
    allowPasswordSignup: true,
});

import pulumi
import pulumi_gcp as gcp

tenant = gcp.identityplatform.Tenant("tenant",
    display_name="tenant",
    allow_password_signup=True)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var tenant = new Gcp.IdentityPlatform.Tenant("tenant", new()
    {
        DisplayName = "tenant",
        AllowPasswordSignup = true,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/identityplatform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := identityplatform.NewTenant(ctx, "tenant", &identityplatform.TenantArgs{
			DisplayName:         pulumi.String("tenant"),
			AllowPasswordSignup: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_identityplatform_tenant" "tenant" {
  display_name          = "tenant"
  allow_password_signup = true
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.identityplatform.Tenant;
import com.pulumi.gcp.identityplatform.TenantArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var tenant = new Tenant("tenant", TenantArgs.builder()
            .displayName("tenant")
            .allowPasswordSignup(true)
            .build());

    }
}

resources:
  tenant:
    type: gcp:identityplatform:Tenant
    properties:
      displayName: tenant
      allowPasswordSignup: true

Import

Tenant can be imported using any of these accepted formats:

projects/{{project}}/tenants/{{name}}
{{project}}/{{name}}
{{name}}

When using the pulumi import command, Tenant can be imported using one of the formats above. For example:

$ pulumi import gcp:identityplatform/tenant:Tenant default projects/{{project}}/tenants/{{name}}
$ pulumi import gcp:identityplatform/tenant:Tenant default {{project}}/{{name}}
$ pulumi import gcp:identityplatform/tenant:Tenant default {{name}}

Constructors

Tenant(String name, {TenantArgs? args, CustomResourceOptions? options}): Creates a new Tenant. name The Pulumi resource name. args Arguments used to configure this Tenant. The set of arguments for Tenant. options Resource options controlling this resource's behavior.
Tenant.reference(String urn): Creates a typed reference to an existing Tenant resource.

Properties

allowPasswordSignup ↔ Output<bool?>: Whether to allow email/password user authentication.
latefinal
childResources → Set<Resource>: finalinherited
client ↔ Output<TenantClient?>: Options related to how clients making requests on behalf of a tenant should be configured. Structure is documented below.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
disableAuth ↔ Output<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.
latefinal
displayName ↔ Output<String>: Human friendly display name of the tenant.
latefinal
enableEmailLinkSignin ↔ Output<bool?>: Whether to enable email link user authentication.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>: The name of the tenant that is generated by the server
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {TenantState? state, CustomResourceOptions? options}) → Tenant: Gets an existing Tenant resource's state with the given name and id.