← All packages

Auth0

Pulumi Official
Package maintained by Pulumi
v2.9.0 published on Thursday, May 26, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. Auth0
  3. Auth0
  4. Tenant

Tenant

With this resource, you can manage Auth0 tenants, including setting logos and support contact information, setting error pages, and configuring default tenant behaviors.

Auth0 does not currently support creating tenants through the Management API. Therefore, this resource can only manage an existing tenant created through the Auth0 dashboard.

Auth0 does not currently support adding/removing extensions on tenants through their API. The Auth0 dashboard must be used to add/remove extensions.

Example Usage

using System.IO;
using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
    public MyStack()
    {
        var tenant = new Auth0.Tenant("tenant", new Auth0.TenantArgs
        {
            ChangePassword = new Auth0.Inputs.TenantChangePasswordArgs
            {
                Enabled = true,
                Html = File.ReadAllText("./password_reset.html"),
            },
            GuardianMfaPage = new Auth0.Inputs.TenantGuardianMfaPageArgs
            {
                Enabled = true,
                Html = File.ReadAllText("./guardian_multifactor.html"),
            },
            DefaultAudience = "<client_id>",
            DefaultDirectory = "Connection-Name",
            ErrorPage = new Auth0.Inputs.TenantErrorPageArgs
            {
                Html = File.ReadAllText("./error.html"),
                ShowLogLink = true,
                Url = "http://mysite/errors",
            },
            FriendlyName = "Tenant Name",
            PictureUrl = "http://mysite/logo.png",
            SupportEmail = "support@mysite",
            SupportUrl = "http://mysite/support",
            AllowedLogoutUrls = 
            {
                "http://mysite/logout",
            },
            SessionLifetime = 46000,
            SandboxVersion = "8",
        });
    }

}

package main

import (
	"io/ioutil"

	"github.com/pulumi/pulumi-auth0/sdk/v2/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := ioutil.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.NewTenant(ctx, "tenant", &auth0.TenantArgs{
			ChangePassword: &TenantChangePasswordArgs{
				Enabled: pulumi.Bool(true),
				Html:    readFileOrPanic("./password_reset.html"),
			},
			GuardianMfaPage: &TenantGuardianMfaPageArgs{
				Enabled: pulumi.Bool(true),
				Html:    readFileOrPanic("./guardian_multifactor.html"),
			},
			DefaultAudience:  pulumi.String("<client_id>"),
			DefaultDirectory: pulumi.String("Connection-Name"),
			ErrorPage: &TenantErrorPageArgs{
				Html:        readFileOrPanic("./error.html"),
				ShowLogLink: pulumi.Bool(true),
				Url:         pulumi.String("http://mysite/errors"),
			},
			FriendlyName: pulumi.String("Tenant Name"),
			PictureUrl:   pulumi.String("http://mysite/logo.png"),
			SupportEmail: pulumi.String("support@mysite"),
			SupportUrl:   pulumi.String("http://mysite/support"),
			AllowedLogoutUrls: pulumi.StringArray{
				pulumi.String("http://mysite/logout"),
			},
			SessionLifetime: pulumi.Float64(46000),
			SandboxVersion:  pulumi.String("8"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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()        
            .changePassword(TenantChangePasswordArgs.builder()
                .enabled(true)
                .html(Files.readString("./password_reset.html"))
                .build())
            .guardianMfaPage(TenantGuardianMfaPageArgs.builder()
                .enabled(true)
                .html(Files.readString("./guardian_multifactor.html"))
                .build())
            .defaultAudience("<client_id>")
            .defaultDirectory("Connection-Name")
            .errorPage(TenantErrorPageArgs.builder()
                .html(Files.readString("./error.html"))
                .showLogLink(true)
                .url("http://mysite/errors")
                .build())
            .friendlyName("Tenant Name")
            .pictureUrl("http://mysite/logo.png")
            .supportEmail("support@mysite")
            .supportUrl("http://mysite/support")
            .allowedLogoutUrls("http://mysite/logout")
            .sessionLifetime(46000)
            .sandboxVersion("8")
            .build());

    }
}

import pulumi
import pulumi_auth0 as auth0

tenant = auth0.Tenant("tenant",
    change_password=auth0.TenantChangePasswordArgs(
        enabled=True,
        html=(lambda path: open(path).read())("./password_reset.html"),
    ),
    guardian_mfa_page=auth0.TenantGuardianMfaPageArgs(
        enabled=True,
        html=(lambda path: open(path).read())("./guardian_multifactor.html"),
    ),
    default_audience="<client_id>",
    default_directory="Connection-Name",
    error_page=auth0.TenantErrorPageArgs(
        html=(lambda path: open(path).read())("./error.html"),
        show_log_link=True,
        url="http://mysite/errors",
    ),
    friendly_name="Tenant Name",
    picture_url="http://mysite/logo.png",
    support_email="support@mysite",
    support_url="http://mysite/support",
    allowed_logout_urls=["http://mysite/logout"],
    session_lifetime=46000,
    sandbox_version="8")

import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";
import * from "fs";

const tenant = new auth0.Tenant("tenant", {
    changePassword: {
        enabled: true,
        html: fs.readFileSync("./password_reset.html"),
    },
    guardianMfaPage: {
        enabled: true,
        html: fs.readFileSync("./guardian_multifactor.html"),
    },
    defaultAudience: "<client_id>",
    defaultDirectory: "Connection-Name",
    errorPage: {
        html: fs.readFileSync("./error.html"),
        showLogLink: true,
        url: "http://mysite/errors",
    },
    friendlyName: "Tenant Name",
    pictureUrl: "http://mysite/logo.png",
    supportEmail: "support@mysite",
    supportUrl: "http://mysite/support",
    allowedLogoutUrls: ["http://mysite/logout"],
    sessionLifetime: 46000,
    sandboxVersion: "8",
});

Coming soon!

Create a Tenant Resource

new Tenant(name: string, args?: TenantArgs, opts?: CustomResourceOptions);
@overload
def Tenant(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           allowed_logout_urls: Optional[Sequence[str]] = None,
           change_password: Optional[TenantChangePasswordArgs] = None,
           default_audience: Optional[str] = None,
           default_directory: Optional[str] = None,
           default_redirection_uri: Optional[str] = None,
           enabled_locales: Optional[Sequence[str]] = None,
           error_page: Optional[TenantErrorPageArgs] = None,
           flags: Optional[TenantFlagsArgs] = None,
           friendly_name: Optional[str] = None,
           guardian_mfa_page: Optional[TenantGuardianMfaPageArgs] = None,
           idle_session_lifetime: Optional[float] = None,
           picture_url: Optional[str] = None,
           sandbox_version: Optional[str] = None,
           session_lifetime: Optional[float] = None,
           support_email: Optional[str] = None,
           support_url: Optional[str] = None,
           universal_login: Optional[TenantUniversalLoginArgs] = None)
@overload
def Tenant(resource_name: str,
           args: Optional[TenantArgs] = None,
           opts: Optional[ResourceOptions] = None)
func NewTenant(ctx *Context, name string, args *TenantArgs, opts ...ResourceOption) (*Tenant, error)
public Tenant(string name, TenantArgs? args = null, CustomResourceOptions? opts = null)
public Tenant(String name, TenantArgs args)
public Tenant(String name, TenantArgs args, CustomResourceOptions options)

type: auth0:Tenant
properties: # The arguments to resource properties.
options: # 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.
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.

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

The Tenant resource accepts the following input properties:

AllowedLogoutUrls List<string>

List(String). URLs that Auth0 may redirect to after logout.

ChangePassword TenantChangePasswordArgs

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

DefaultAudience string

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

DefaultDirectory string

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

DefaultRedirectionUri string

String. The default absolute redirection uri, must be https and cannot contain a fragment.

EnabledLocales List<string>

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

ErrorPage TenantErrorPageArgs

List(Resource). Configuration settings for error pages. For details, see Error Page.

Flags TenantFlagsArgs

List(Resource). Configuration settings for tenant flags. For details, see Flags.

FriendlyName string

String. Friendly name for the tenant.

GuardianMfaPage TenantGuardianMfaPageArgs

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

IdleSessionLifetime double

Integer. Number of hours during which a session can be inactive before the user must log in again.

PictureUrl string

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

SandboxVersion string

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

SessionLifetime double

Integer. Number of hours during which a session will stay valid.

SupportEmail string

String. Support email address for authenticating users.

SupportUrl string

String. Support URL for authenticating users.

UniversalLogin TenantUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

AllowedLogoutUrls []string

List(String). URLs that Auth0 may redirect to after logout.

ChangePassword TenantChangePasswordArgs

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

DefaultAudience string

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

DefaultDirectory string

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

DefaultRedirectionUri string

String. The default absolute redirection uri, must be https and cannot contain a fragment.

EnabledLocales []string

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

ErrorPage TenantErrorPageArgs

List(Resource). Configuration settings for error pages. For details, see Error Page.

Flags TenantFlagsArgs

List(Resource). Configuration settings for tenant flags. For details, see Flags.

FriendlyName string

String. Friendly name for the tenant.

GuardianMfaPage TenantGuardianMfaPageArgs

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

IdleSessionLifetime float64

Integer. Number of hours during which a session can be inactive before the user must log in again.

PictureUrl string

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

SandboxVersion string

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

SessionLifetime float64

Integer. Number of hours during which a session will stay valid.

SupportEmail string

String. Support email address for authenticating users.

SupportUrl string

String. Support URL for authenticating users.

UniversalLogin TenantUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

allowedLogoutUrls List<String>

List(String). URLs that Auth0 may redirect to after logout.

changePassword TenantChangePasswordArgs

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

defaultAudience String

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

defaultDirectory String

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

defaultRedirectionUri String

String. The default absolute redirection uri, must be https and cannot contain a fragment.

enabledLocales List<String>

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

errorPage TenantErrorPageArgs

List(Resource). Configuration settings for error pages. For details, see Error Page.

flags TenantFlagsArgs

List(Resource). Configuration settings for tenant flags. For details, see Flags.

friendlyName String

String. Friendly name for the tenant.

guardianMfaPage TenantGuardianMfaPageArgs

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

idleSessionLifetime Double

Integer. Number of hours during which a session can be inactive before the user must log in again.

pictureUrl String

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

sandboxVersion String

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

sessionLifetime Double

Integer. Number of hours during which a session will stay valid.

supportEmail String

String. Support email address for authenticating users.

supportUrl String

String. Support URL for authenticating users.

universalLogin TenantUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

allowedLogoutUrls string[]

List(String). URLs that Auth0 may redirect to after logout.

changePassword TenantChangePasswordArgs

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

defaultAudience string

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

defaultDirectory string

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

defaultRedirectionUri string

String. The default absolute redirection uri, must be https and cannot contain a fragment.

enabledLocales string[]

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

errorPage TenantErrorPageArgs

List(Resource). Configuration settings for error pages. For details, see Error Page.

flags TenantFlagsArgs

List(Resource). Configuration settings for tenant flags. For details, see Flags.

friendlyName string

String. Friendly name for the tenant.

guardianMfaPage TenantGuardianMfaPageArgs

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

idleSessionLifetime number

Integer. Number of hours during which a session can be inactive before the user must log in again.

pictureUrl string

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

sandboxVersion string

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

sessionLifetime number

Integer. Number of hours during which a session will stay valid.

supportEmail string

String. Support email address for authenticating users.

supportUrl string

String. Support URL for authenticating users.

universalLogin TenantUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

allowed_logout_urls Sequence[str]

List(String). URLs that Auth0 may redirect to after logout.

change_password TenantChangePasswordArgs

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

default_audience str

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

default_directory str

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

default_redirection_uri str

String. The default absolute redirection uri, must be https and cannot contain a fragment.

enabled_locales Sequence[str]

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

error_page TenantErrorPageArgs

List(Resource). Configuration settings for error pages. For details, see Error Page.

flags TenantFlagsArgs

List(Resource). Configuration settings for tenant flags. For details, see Flags.

friendly_name str

String. Friendly name for the tenant.

guardian_mfa_page TenantGuardianMfaPageArgs

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

idle_session_lifetime float

Integer. Number of hours during which a session can be inactive before the user must log in again.

picture_url str

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

sandbox_version str

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

session_lifetime float

Integer. Number of hours during which a session will stay valid.

support_email str

String. Support email address for authenticating users.

support_url str

String. Support URL for authenticating users.

universal_login TenantUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

allowedLogoutUrls List<String>

List(String). URLs that Auth0 may redirect to after logout.

changePassword Property Map

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

defaultAudience String

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

defaultDirectory String

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

defaultRedirectionUri String

String. The default absolute redirection uri, must be https and cannot contain a fragment.

enabledLocales List<String>

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

errorPage Property Map

List(Resource). Configuration settings for error pages. For details, see Error Page.

flags Property Map

List(Resource). Configuration settings for tenant flags. For details, see Flags.

friendlyName String

String. Friendly name for the tenant.

guardianMfaPage Property Map

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

idleSessionLifetime Number

Integer. Number of hours during which a session can be inactive before the user must log in again.

pictureUrl String

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

sandboxVersion String

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

sessionLifetime Number

Integer. Number of hours during which a session will stay valid.

supportEmail String

String. Support email address for authenticating users.

supportUrl String

String. Support URL for authenticating users.

universalLogin Property Map

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

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.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_logout_urls: Optional[Sequence[str]] = None,
        change_password: Optional[TenantChangePasswordArgs] = None,
        default_audience: Optional[str] = None,
        default_directory: Optional[str] = None,
        default_redirection_uri: Optional[str] = None,
        enabled_locales: Optional[Sequence[str]] = None,
        error_page: Optional[TenantErrorPageArgs] = None,
        flags: Optional[TenantFlagsArgs] = None,
        friendly_name: Optional[str] = None,
        guardian_mfa_page: Optional[TenantGuardianMfaPageArgs] = None,
        idle_session_lifetime: Optional[float] = None,
        picture_url: Optional[str] = None,
        sandbox_version: Optional[str] = None,
        session_lifetime: Optional[float] = None,
        support_email: Optional[str] = None,
        support_url: Optional[str] = None,
        universal_login: Optional[TenantUniversalLoginArgs] = 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:
AllowedLogoutUrls List<string>

List(String). URLs that Auth0 may redirect to after logout.

ChangePassword TenantChangePasswordArgs

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

DefaultAudience string

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

DefaultDirectory string

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

DefaultRedirectionUri string

String. The default absolute redirection uri, must be https and cannot contain a fragment.

EnabledLocales List<string>

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

ErrorPage TenantErrorPageArgs

List(Resource). Configuration settings for error pages. For details, see Error Page.

Flags TenantFlagsArgs

List(Resource). Configuration settings for tenant flags. For details, see Flags.

FriendlyName string

String. Friendly name for the tenant.

GuardianMfaPage TenantGuardianMfaPageArgs

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

IdleSessionLifetime double

Integer. Number of hours during which a session can be inactive before the user must log in again.

PictureUrl string

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

SandboxVersion string

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

SessionLifetime double

Integer. Number of hours during which a session will stay valid.

SupportEmail string

String. Support email address for authenticating users.

SupportUrl string

String. Support URL for authenticating users.

UniversalLogin TenantUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

AllowedLogoutUrls []string

List(String). URLs that Auth0 may redirect to after logout.

ChangePassword TenantChangePasswordArgs

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

DefaultAudience string

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

DefaultDirectory string

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

DefaultRedirectionUri string

String. The default absolute redirection uri, must be https and cannot contain a fragment.

EnabledLocales []string

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

ErrorPage TenantErrorPageArgs

List(Resource). Configuration settings for error pages. For details, see Error Page.

Flags TenantFlagsArgs

List(Resource). Configuration settings for tenant flags. For details, see Flags.

FriendlyName string

String. Friendly name for the tenant.

GuardianMfaPage TenantGuardianMfaPageArgs

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

IdleSessionLifetime float64

Integer. Number of hours during which a session can be inactive before the user must log in again.

PictureUrl string

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

SandboxVersion string

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

SessionLifetime float64

Integer. Number of hours during which a session will stay valid.

SupportEmail string

String. Support email address for authenticating users.

SupportUrl string

String. Support URL for authenticating users.

UniversalLogin TenantUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

allowedLogoutUrls List<String>

List(String). URLs that Auth0 may redirect to after logout.

changePassword TenantChangePasswordArgs

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

defaultAudience String

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

defaultDirectory String

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

defaultRedirectionUri String

String. The default absolute redirection uri, must be https and cannot contain a fragment.

enabledLocales List<String>

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

errorPage TenantErrorPageArgs

List(Resource). Configuration settings for error pages. For details, see Error Page.

flags TenantFlagsArgs

List(Resource). Configuration settings for tenant flags. For details, see Flags.

friendlyName String

String. Friendly name for the tenant.

guardianMfaPage TenantGuardianMfaPageArgs

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

idleSessionLifetime Double

Integer. Number of hours during which a session can be inactive before the user must log in again.

pictureUrl String

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

sandboxVersion String

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

sessionLifetime Double

Integer. Number of hours during which a session will stay valid.

supportEmail String

String. Support email address for authenticating users.

supportUrl String

String. Support URL for authenticating users.

universalLogin TenantUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

allowedLogoutUrls string[]

List(String). URLs that Auth0 may redirect to after logout.

changePassword TenantChangePasswordArgs

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

defaultAudience string

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

defaultDirectory string

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

defaultRedirectionUri string

String. The default absolute redirection uri, must be https and cannot contain a fragment.

enabledLocales string[]

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

errorPage TenantErrorPageArgs

List(Resource). Configuration settings for error pages. For details, see Error Page.

flags TenantFlagsArgs

List(Resource). Configuration settings for tenant flags. For details, see Flags.

friendlyName string

String. Friendly name for the tenant.

guardianMfaPage TenantGuardianMfaPageArgs

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

idleSessionLifetime number

Integer. Number of hours during which a session can be inactive before the user must log in again.

pictureUrl string

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

sandboxVersion string

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

sessionLifetime number

Integer. Number of hours during which a session will stay valid.

supportEmail string

String. Support email address for authenticating users.

supportUrl string

String. Support URL for authenticating users.

universalLogin TenantUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

allowed_logout_urls Sequence[str]

List(String). URLs that Auth0 may redirect to after logout.

change_password TenantChangePasswordArgs

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

default_audience str

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

default_directory str

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

default_redirection_uri str

String. The default absolute redirection uri, must be https and cannot contain a fragment.

enabled_locales Sequence[str]

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

error_page TenantErrorPageArgs

List(Resource). Configuration settings for error pages. For details, see Error Page.

flags TenantFlagsArgs

List(Resource). Configuration settings for tenant flags. For details, see Flags.

friendly_name str

String. Friendly name for the tenant.

guardian_mfa_page TenantGuardianMfaPageArgs

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

idle_session_lifetime float

Integer. Number of hours during which a session can be inactive before the user must log in again.

picture_url str

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

sandbox_version str

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

session_lifetime float

Integer. Number of hours during which a session will stay valid.

support_email str

String. Support email address for authenticating users.

support_url str

String. Support URL for authenticating users.

universal_login TenantUniversalLoginArgs

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

allowedLogoutUrls List<String>

List(String). URLs that Auth0 may redirect to after logout.

changePassword Property Map

List(Resource). Configuration settings for change passsword page. For details, see Change Password Page.

defaultAudience String

String. API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.

defaultDirectory String

String. Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.

defaultRedirectionUri String

String. The default absolute redirection uri, must be https and cannot contain a fragment.

enabledLocales List<String>

List(String). Supported locales for the user interface. The first locale in the list will be used to set the default locale.

errorPage Property Map

List(Resource). Configuration settings for error pages. For details, see Error Page.

flags Property Map

List(Resource). Configuration settings for tenant flags. For details, see Flags.

friendlyName String

String. Friendly name for the tenant.

guardianMfaPage Property Map

List(Resource). Configuration settings for the Guardian MFA page. For details, see Guardian MFA Page.

idleSessionLifetime Number

Integer. Number of hours during which a session can be inactive before the user must log in again.

pictureUrl String

. String URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.

sandboxVersion String

String. Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.

sessionLifetime Number

Integer. Number of hours during which a session will stay valid.

supportEmail String

String. Support email address for authenticating users.

supportUrl String

String. Support URL for authenticating users.

universalLogin Property Map

List(Resource). Configuration settings for Universal Login. For details, see Universal Login.

Supporting Types

TenantChangePassword

Enabled bool

Boolean. Indicates whether to use the custom change password page.

Html string

String, HTML format with supported Liquid syntax. Customized content of the change password page.

Enabled bool

Boolean. Indicates whether to use the custom change password page.

Html string

String, HTML format with supported Liquid syntax. Customized content of the change password page.

enabled Boolean

Boolean. Indicates whether to use the custom change password page.

html String

String, HTML format with supported Liquid syntax. Customized content of the change password page.

enabled boolean

Boolean. Indicates whether to use the custom change password page.

html string

String, HTML format with supported Liquid syntax. Customized content of the change password page.

enabled bool

Boolean. Indicates whether to use the custom change password page.

html str

String, HTML format with supported Liquid syntax. Customized content of the change password page.

enabled Boolean

Boolean. Indicates whether to use the custom change password page.

html String

String, HTML format with supported Liquid syntax. Customized content of the change password page.

TenantErrorPage

Html string

String, HTML format with supported Liquid syntax. Customized content of the error page.

ShowLogLink bool

Boolean. Indicates whether to show the link to logs as part of the default error page.

Url string

String. URL to redirect to when an error occurs rather than showing the default error page.

Html string

String, HTML format with supported Liquid syntax. Customized content of the error page.

ShowLogLink bool

Boolean. Indicates whether to show the link to logs as part of the default error page.

Url string

String. URL to redirect to when an error occurs rather than showing the default error page.

html String

String, HTML format with supported Liquid syntax. Customized content of the error page.

showLogLink Boolean

Boolean. Indicates whether to show the link to logs as part of the default error page.

url String

String. URL to redirect to when an error occurs rather than showing the default error page.

html string

String, HTML format with supported Liquid syntax. Customized content of the error page.

showLogLink boolean

Boolean. Indicates whether to show the link to logs as part of the default error page.

url string

String. URL to redirect to when an error occurs rather than showing the default error page.

html str

String, HTML format with supported Liquid syntax. Customized content of the error page.

show_log_link bool

Boolean. Indicates whether to show the link to logs as part of the default error page.

url str

String. URL to redirect to when an error occurs rather than showing the default error page.

html String

String, HTML format with supported Liquid syntax. Customized content of the error page.

showLogLink Boolean

Boolean. Indicates whether to show the link to logs as part of the default error page.

url String

String. URL to redirect to when an error occurs rather than showing the default error page.

TenantFlags

DisableClickjackProtectionHeaders bool

Boolean. Indicated whether classic Universal Login prompts include additional security headers to prevent clickjacking.

EnableApisSection bool

Boolean. Indicates whether the APIs section is enabled for the tenant.

EnableClientConnections bool

Boolean. Indicates whether all current connections should be enabled when a new client is created.

EnableCustomDomainInEmails bool

Boolean. Indicates whether the tenant allows custom domains in emails.

EnableDynamicClientRegistration bool

Boolean. Indicates whether the tenant allows dynamic client registration.

EnableLegacyLogsSearchV2 bool

Boolean. Indicates whether to use the older v2 legacy logs search.

EnablePipeline2 bool

Boolean. Indicates whether advanced API Authorization scenarios are enabled.

EnablePublicSignupUserExistsError bool

Boolean. Indicates whether the public sign up process shows a user_exists error if the user already exists.

UniversalLogin bool

Boolean. Indicates whether the tenant uses universal login.

UseScopeDescriptionsForConsent bool
DisableClickjackProtectionHeaders bool

Boolean. Indicated whether classic Universal Login prompts include additional security headers to prevent clickjacking.

EnableApisSection bool

Boolean. Indicates whether the APIs section is enabled for the tenant.

EnableClientConnections bool

Boolean. Indicates whether all current connections should be enabled when a new client is created.

EnableCustomDomainInEmails bool

Boolean. Indicates whether the tenant allows custom domains in emails.

EnableDynamicClientRegistration bool

Boolean. Indicates whether the tenant allows dynamic client registration.

EnableLegacyLogsSearchV2 bool

Boolean. Indicates whether to use the older v2 legacy logs search.

EnablePipeline2 bool

Boolean. Indicates whether advanced API Authorization scenarios are enabled.

EnablePublicSignupUserExistsError bool

Boolean. Indicates whether the public sign up process shows a user_exists error if the user already exists.

UniversalLogin bool

Boolean. Indicates whether the tenant uses universal login.

UseScopeDescriptionsForConsent bool
disableClickjackProtectionHeaders Boolean

Boolean. Indicated whether classic Universal Login prompts include additional security headers to prevent clickjacking.

enableApisSection Boolean

Boolean. Indicates whether the APIs section is enabled for the tenant.

enableClientConnections Boolean

Boolean. Indicates whether all current connections should be enabled when a new client is created.

enableCustomDomainInEmails Boolean

Boolean. Indicates whether the tenant allows custom domains in emails.

enableDynamicClientRegistration Boolean

Boolean. Indicates whether the tenant allows dynamic client registration.

enableLegacyLogsSearchV2 Boolean

Boolean. Indicates whether to use the older v2 legacy logs search.

enablePipeline2 Boolean

Boolean. Indicates whether advanced API Authorization scenarios are enabled.

enablePublicSignupUserExistsError Boolean

Boolean. Indicates whether the public sign up process shows a user_exists error if the user already exists.

universalLogin Boolean

Boolean. Indicates whether the tenant uses universal login.

useScopeDescriptionsForConsent Boolean
disableClickjackProtectionHeaders boolean

Boolean. Indicated whether classic Universal Login prompts include additional security headers to prevent clickjacking.

enableApisSection boolean

Boolean. Indicates whether the APIs section is enabled for the tenant.

enableClientConnections boolean

Boolean. Indicates whether all current connections should be enabled when a new client is created.

enableCustomDomainInEmails boolean

Boolean. Indicates whether the tenant allows custom domains in emails.

enableDynamicClientRegistration boolean

Boolean. Indicates whether the tenant allows dynamic client registration.

enableLegacyLogsSearchV2 boolean

Boolean. Indicates whether to use the older v2 legacy logs search.

enablePipeline2 boolean

Boolean. Indicates whether advanced API Authorization scenarios are enabled.

enablePublicSignupUserExistsError boolean

Boolean. Indicates whether the public sign up process shows a user_exists error if the user already exists.

universalLogin boolean

Boolean. Indicates whether the tenant uses universal login.

useScopeDescriptionsForConsent boolean
disable_clickjack_protection_headers bool

Boolean. Indicated whether classic Universal Login prompts include additional security headers to prevent clickjacking.

enable_apis_section bool

Boolean. Indicates whether the APIs section is enabled for the tenant.

enable_client_connections bool

Boolean. Indicates whether all current connections should be enabled when a new client is created.

enable_custom_domain_in_emails bool

Boolean. Indicates whether the tenant allows custom domains in emails.

enable_dynamic_client_registration bool

Boolean. Indicates whether the tenant allows dynamic client registration.

enable_legacy_logs_search_v2 bool

Boolean. Indicates whether to use the older v2 legacy logs search.

enable_pipeline2 bool

Boolean. Indicates whether advanced API Authorization scenarios are enabled.

enable_public_signup_user_exists_error bool

Boolean. Indicates whether the public sign up process shows a user_exists error if the user already exists.

universal_login bool

Boolean. Indicates whether the tenant uses universal login.

use_scope_descriptions_for_consent bool
disableClickjackProtectionHeaders Boolean

Boolean. Indicated whether classic Universal Login prompts include additional security headers to prevent clickjacking.

enableApisSection Boolean

Boolean. Indicates whether the APIs section is enabled for the tenant.

enableClientConnections Boolean

Boolean. Indicates whether all current connections should be enabled when a new client is created.

enableCustomDomainInEmails Boolean

Boolean. Indicates whether the tenant allows custom domains in emails.

enableDynamicClientRegistration Boolean

Boolean. Indicates whether the tenant allows dynamic client registration.

enableLegacyLogsSearchV2 Boolean

Boolean. Indicates whether to use the older v2 legacy logs search.

enablePipeline2 Boolean

Boolean. Indicates whether advanced API Authorization scenarios are enabled.

enablePublicSignupUserExistsError Boolean

Boolean. Indicates whether the public sign up process shows a user_exists error if the user already exists.

universalLogin Boolean

Boolean. Indicates whether the tenant uses universal login.

useScopeDescriptionsForConsent Boolean

TenantGuardianMfaPage

Enabled bool

Boolean. Indicates whether to use the custom Guardian page.

Html string

String, HTML format with supported Liquid syntax. Customized content of the Guardian page.

Enabled bool

Boolean. Indicates whether to use the custom Guardian page.

Html string

String, HTML format with supported Liquid syntax. Customized content of the Guardian page.

enabled Boolean

Boolean. Indicates whether to use the custom Guardian page.

html String

String, HTML format with supported Liquid syntax. Customized content of the Guardian page.

enabled boolean

Boolean. Indicates whether to use the custom Guardian page.

html string

String, HTML format with supported Liquid syntax. Customized content of the Guardian page.

enabled bool

Boolean. Indicates whether to use the custom Guardian page.

html str

String, HTML format with supported Liquid syntax. Customized content of the Guardian page.

enabled Boolean

Boolean. Indicates whether to use the custom Guardian page.

html String

String, HTML format with supported Liquid syntax. Customized content of the Guardian page.

TenantUniversalLogin

Colors TenantUniversalLoginColors

List(Resource). Configuration settings for Universal Login colors. See Universal Login - Colors.

Colors TenantUniversalLoginColors

List(Resource). Configuration settings for Universal Login colors. See Universal Login - Colors.

colors TenantUniversalLoginColors

List(Resource). Configuration settings for Universal Login colors. See Universal Login - Colors.

colors TenantUniversalLoginColors

List(Resource). Configuration settings for Universal Login colors. See Universal Login - Colors.

colors TenantUniversalLoginColors

List(Resource). Configuration settings for Universal Login colors. See Universal Login - Colors.

colors Property Map

List(Resource). Configuration settings for Universal Login colors. See Universal Login - Colors.

TenantUniversalLoginColors

PageBackground string

String, Hexadecimal. Background color of login pages.

Primary string

String, Hexadecimal. Primary button background color.

PageBackground string

String, Hexadecimal. Background color of login pages.

Primary string

String, Hexadecimal. Primary button background color.

pageBackground String

String, Hexadecimal. Background color of login pages.

primary String

String, Hexadecimal. Primary button background color.

pageBackground string

String, Hexadecimal. Background color of login pages.

primary string

String, Hexadecimal. Primary button background color.

page_background str

String, Hexadecimal. Background color of login pages.

primary str

String, Hexadecimal. Primary button background color.

pageBackground String

String, Hexadecimal. Background color of login pages.

primary String

String, Hexadecimal. Primary button background color.

Import

As this is not a resource identifiable by an ID within the Auth0 Management API, tenant can be imported using a random string. We recommend Version 4 UUID e.g.

 $ pulumi import auth0:index/tenant:Tenant tenant 82f4f21b-017a-319d-92e7-2291c1ca36c4

Package Details

Repository
https://github.com/pulumi/pulumi-auth0
License
Apache-2.0
Notes

This Pulumi package is based on the auth0 Terraform Provider.