Class Tenant

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

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
    {
        AllowedLogoutUrls = 
        {
            "http://mysite/logout",
        },
        ChangePassword = new Auth0.Inputs.TenantChangePasswordArgs
        {
            Enabled = true,
            Html = File.ReadAllText("./password_reset.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",
        GuardianMfaPage = new Auth0.Inputs.TenantGuardianMfaPageArgs
        {
            Enabled = true,
            Html = File.ReadAllText("./guardian_multifactor.html"),
        },
        PictureUrl = "http://mysite/logo.png",
        SandboxVersion = "8",
        SessionLifetime = 46000,
        SupportEmail = "support@mysite",
        SupportUrl = "http://mysite/support",
    });
}

}
Inheritance
System.Object
Pulumi.Resource
Pulumi.CustomResource
Tenant
Inherited Members
Pulumi.CustomResource.Id
Pulumi.Resource.GetResourceType()
Pulumi.Resource.GetResourceName()
Pulumi.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.Auth0
Assembly: Pulumi.Auth0.dll
Syntax
public class Tenant : CustomResource

Constructors

View Source

Tenant(String, TenantArgs, CustomResourceOptions)

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

Declaration
public Tenant(string name, TenantArgs args = null, 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
Pulumi.CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AllowedLogoutUrls

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

Declaration
public Output<ImmutableArray<string>> AllowedLogoutUrls { get; }
Property Value
Type Description
Pulumi.Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

ChangePassword

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

Declaration
public Output<TenantChangePassword> ChangePassword { get; }
Property Value
Type Description
Pulumi.Output<TenantChangePassword>
View Source

DefaultAudience

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.

Declaration
public Output<string> DefaultAudience { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

DefaultDirectory

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

Declaration
public Output<string> DefaultDirectory { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

DefaultRedirectionUri

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

Declaration
public Output<string> DefaultRedirectionUri { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

EnabledLocales

Declaration
public Output<ImmutableArray<string>> EnabledLocales { get; }
Property Value
Type Description
Pulumi.Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

ErrorPage

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

Declaration
public Output<TenantErrorPage> ErrorPage { get; }
Property Value
Type Description
Pulumi.Output<TenantErrorPage>
View Source

Flags

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

Declaration
public Output<TenantFlags> Flags { get; }
Property Value
Type Description
Pulumi.Output<TenantFlags>
View Source

FriendlyName

String. Friendly name for the tenant.

Declaration
public Output<string> FriendlyName { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

GuardianMfaPage

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

Declaration
public Output<TenantGuardianMfaPage> GuardianMfaPage { get; }
Property Value
Type Description
Pulumi.Output<TenantGuardianMfaPage>
View Source

IdleSessionLifetime

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

Declaration
public Output<int> IdleSessionLifetime { get; }
Property Value
Type Description
Pulumi.Output<System.Int32>
View Source

PictureUrl

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

Declaration
public Output<string> PictureUrl { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

SandboxVersion

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

Declaration
public Output<string> SandboxVersion { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

SessionLifetime

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

Declaration
public Output<int> SessionLifetime { get; }
Property Value
Type Description
Pulumi.Output<System.Int32>
View Source

SupportEmail

String. Support email address for authenticating users.

Declaration
public Output<string> SupportEmail { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

SupportUrl

String. Support URL for authenticating users.

Declaration
public Output<string> SupportUrl { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

UniversalLogin

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

Declaration
public Output<TenantUniversalLogin> UniversalLogin { get; }
Property Value
Type Description
Pulumi.Output<TenantUniversalLogin>

Methods

View Source

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.
Pulumi.Input<System.String> id

The unique provider ID of the resource to lookup.
TenantState state

Any extra arguments used during the lookup.
Pulumi.CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Tenant