Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. identityplatform
  5. Tenant
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.identityplatform.Tenant

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

    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)

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

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

    Create Tenant Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Tenant(name: string, args: TenantArgs, opts?: CustomResourceOptions);
    @overload
def Tenant(resource_name: str,
           args: TenantArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Tenant(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           display_name: Optional[str] = None,
           allow_password_signup: Optional[bool] = None,
           disable_auth: Optional[bool] = None,
           enable_email_link_signin: Optional[bool] = None,
           project: Optional[str] = None)
    func NewTenant(ctx *Context, name string, args TenantArgs, opts ...ResourceOption) (*Tenant, error)
    public Tenant(string name, TenantArgs args, CustomResourceOptions? opts = null)
    public Tenant(String name, TenantArgs args)
public Tenant(String name, TenantArgs args, CustomResourceOptions options)

    type: gcp:identityplatform:Tenant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args TenantArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args TenantArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var tenantResource = new Gcp.IdentityPlatform.Tenant("tenantResource", new()
{
    DisplayName = "string",
    AllowPasswordSignup = false,
    DisableAuth = false,
    EnableEmailLinkSignin = false,
    Project = "string",
});

    example, err := identityplatform.NewTenant(ctx, "tenantResource", &identityplatform.TenantArgs{
	DisplayName:           pulumi.String("string"),
	AllowPasswordSignup:   pulumi.Bool(false),
	DisableAuth:           pulumi.Bool(false),
	EnableEmailLinkSignin: pulumi.Bool(false),
	Project:               pulumi.String("string"),
})

    var tenantResource = new Tenant("tenantResource", TenantArgs.builder()
    .displayName("string")
    .allowPasswordSignup(false)
    .disableAuth(false)
    .enableEmailLinkSignin(false)
    .project("string")
    .build());

    tenant_resource = gcp.identityplatform.Tenant("tenantResource",
    display_name="string",
    allow_password_signup=False,
    disable_auth=False,
    enable_email_link_signin=False,
    project="string")

    const tenantResource = new gcp.identityplatform.Tenant("tenantResource", {
    displayName: "string",
    allowPasswordSignup: false,
    disableAuth: false,
    enableEmailLinkSignin: false,
    project: "string",
});

    type: gcp:identityplatform:Tenant
properties:
    allowPasswordSignup: false
    disableAuth: false
    displayName: string
    enableEmailLinkSignin: false
    project: string

    Tenant Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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

    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 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
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the tenant that is generated by the server

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_password_signup: Optional[bool] = None,
        disable_auth: Optional[bool] = None,
        display_name: Optional[str] = None,
        enable_email_link_signin: Optional[bool] = None,
        name: Optional[str] = None,
        project: Optional[str] = None) -> Tenant
    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)
    public static Tenant get(String name, Output<String> id, TenantState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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.
    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.
    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.

    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}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-gcp