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",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.NewCustomDomain(ctx, "myCustomDomain", &auth0.CustomDomainArgs{
			Domain:             pulumi.String("auth.example.com"),
			Type:               pulumi.String("auth0_managed_certs"),
			VerificationMethod: pulumi.String("txt"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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);
@overload
def CustomDomain(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 domain: Optional[str] = None,
                 type: Optional[str] = None,
                 verification_method: Optional[str] = None)
@overload
def CustomDomain(resource_name: str,
                 args: CustomDomainArgs,
                 opts: Optional[ResourceOptions] = 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.
args CustomDomainArgs
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 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 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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain: Optional[str] = None,
        primary: Optional[bool] = None,
        status: Optional[str] = None,
        type: Optional[str] = None,
        verification: Optional[CustomDomainVerificationArgs] = None,
        verification_method: Optional[str] = None) -> CustomDomain
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 CustomDomainVerificationArgs
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 CustomDomainVerificationArgs
List(Resource). Configuration settings for verification. For details, see Verification.
verification_method str
String. Domain verification method. Options include txt.

Supporting Types

CustomDomainVerification

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