pulumi-gcp-kotlin/com.pulumi.gcp.identityplatform.kotlin/TenantArgs

TenantArgs

data class TenantArgs(val allowPasswordSignup: Output<Boolean>? = null, val client: Output<TenantClientArgs>? = null, val disableAuth: Output<Boolean>? = null, val displayName: Output<String>? = null, val enableEmailLinkSignin: Output<Boolean>? = null, val project: Output<String>? = null) : ConvertibleToJava<TenantArgs>

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/v8/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
	})
}

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.List;
import java.util.ArrayList;
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

TenantArgs

constructor(allowPasswordSignup: Output<Boolean>? = null, client: Output<TenantClientArgs>? = null, disableAuth: Output<Boolean>? = null, displayName: Output<String>? = null, enableEmailLinkSignin: Output<Boolean>? = null, project: Output<String>? = null)

Properties

allowPasswordSignup

val allowPasswordSignup: Output<Boolean>? = null

Whether to allow email/password user authentication.

client

val client: Output<TenantClientArgs>? = null

Options related to how clients making requests on behalf of a tenant should be configured. Structure is documented below.

disableAuth

val disableAuth: Output<Boolean>? = null

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

val displayName: Output<String>? = null

Human friendly display name of the tenant.

enableEmailLinkSignin

val enableEmailLinkSignin: Output<Boolean>? = null

Whether to enable email link user authentication.

project

val project: Output<String>? = null

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

Functions

toJava

open override fun toJava(): TenantArgs