CustomDomain

With Auth0, you can use a custom domain to maintain a consistent user experience. This resource allows you to create and manage a custom domain within your Auth0 tenant.

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
    public MyStack()
    {
        var myCustomDomain = new Auth0.CustomDomain("myCustomDomain", new Auth0.CustomDomainArgs
        {
            Domain = "auth.example.com",
            Type = "auth0_managed_certs",
            VerificationMethod = "txt",
        });
    }

}

Coming soon!

import pulumi
import pulumi_auth0 as auth0

my_custom_domain = auth0.CustomDomain("myCustomDomain",
    domain="auth.example.com",
    type="auth0_managed_certs",
    verification_method="txt")

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

const myCustomDomain = new auth0.CustomDomain("my_custom_domain", {
    domain: "auth.example.com",
    type: "auth0_managed_certs",
    verificationMethod: "txt",
});

Create a CustomDomain Resource

new CustomDomain(name: string, args: CustomDomainArgs, opts?: CustomResourceOptions);

def CustomDomain(resource_name, opts=None, domain=None, type=None, verification_method=None, __props__=None);

func NewCustomDomain(ctx *Context, name string, args CustomDomainArgs, opts ...ResourceOption) (*CustomDomain, error)

public CustomDomain(string name, CustomDomainArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args CustomDomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CustomDomainArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CustomDomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

CustomDomain Resource Properties

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

Inputs

The CustomDomain resource accepts the following input properties:

Domain string: String. Name of the custom domain.
Type string: String. Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
VerificationMethod string: String. Domain verification method. Options include txt.

Domain string: String. Name of the custom domain.
Type string: String. Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
VerificationMethod string: String. Domain verification method. Options include txt.

domain string: String. Name of the custom domain.
type string: String. Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
verificationMethod string: String. Domain verification method. Options include txt.

domain str: String. Name of the custom domain.
type str: String. Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
verification_method str: String. Domain verification method. Options include txt.

Outputs

All input properties are implicitly available as output properties. Additionally, the CustomDomain resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Primary bool: Boolean. Indicates whether or not this is a primary domain.
Status string: String. Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
Verification CustomDomainVerification: List(Resource). Configuration settings for verification. For details, see Verification.

Id string: The provider-assigned unique ID for this managed resource.
Primary bool: Boolean. Indicates whether or not this is a primary domain.
Status string: String. Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
Verification CustomDomainVerification: List(Resource). Configuration settings for verification. For details, see Verification.

id string: The provider-assigned unique ID for this managed resource.
primary boolean: Boolean. Indicates whether or not this is a primary domain.
status string: String. Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
verification CustomDomainVerification: List(Resource). Configuration settings for verification. For details, see Verification.

id str: The provider-assigned unique ID for this managed resource.
primary bool: Boolean. Indicates whether or not this is a primary domain.
status str: String. Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
verification Dict[CustomDomainVerification]: List(Resource). Configuration settings for verification. For details, see Verification.

Look up an Existing CustomDomain Resource

Get an existing CustomDomain 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?: CustomDomainState, opts?: CustomResourceOptions): CustomDomain

static get(resource_name, id, opts=None, domain=None, primary=None, status=None, type=None, verification=None, verification_method=None, __props__=None);

func GetCustomDomain(ctx *Context, name string, id IDInput, state *CustomDomainState, opts ...ResourceOption) (*CustomDomain, error)

public static CustomDomain Get(string name, Input<string> id, CustomDomainState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Domain string: String. Name of the custom domain.
Primary bool: Boolean. Indicates whether or not this is a primary domain.
Status string: String. Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
Type string: String. Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
Verification CustomDomainVerificationArgs: List(Resource). Configuration settings for verification. For details, see Verification.
VerificationMethod string: String. Domain verification method. Options include txt.

Domain string: String. Name of the custom domain.
Primary bool: Boolean. Indicates whether or not this is a primary domain.
Status string: String. Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
Type string: String. Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
Verification CustomDomainVerification: List(Resource). Configuration settings for verification. For details, see Verification.
VerificationMethod string: String. Domain verification method. Options include txt.

domain string: String. Name of the custom domain.
primary boolean: Boolean. Indicates whether or not this is a primary domain.
status string: String. Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
type string: String. Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
verification CustomDomainVerification: List(Resource). Configuration settings for verification. For details, see Verification.
verificationMethod string: String. Domain verification method. Options include txt.

domain str: String. Name of the custom domain.
primary bool: Boolean. Indicates whether or not this is a primary domain.
status str: String. Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
type str: String. Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
verification Dict[CustomDomainVerification]: List(Resource). Configuration settings for verification. For details, see Verification.
verification_method str: String. Domain verification method. Options include txt.

Supporting Types

CustomDomainVerification

See the output API doc for this type.

Methods List<object>: List(Map). Verification methods for the domain.

Methods []interface{}: List(Map). Verification methods for the domain.

methods any[]: List(Map). Verification methods for the domain.

methods List[Any]: List(Map). Verification methods for the domain.

Package Details

Repository: https://github.com/pulumi/pulumi-auth0
License: Apache-2.0
Notes: This Pulumi package is based on the auth0 Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud