Auth0 v2.18.0, Mar 20 23

auth0.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 System.Collections.Generic;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var myCustomDomain = new Auth0.CustomDomain("myCustomDomain", new()
    {
        Domain = "auth.example.com",
        Type = "auth0_managed_certs",
    });

});

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"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.CustomDomain;
import com.pulumi.auth0.CustomDomainArgs;
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 myCustomDomain = new CustomDomain("myCustomDomain", CustomDomainArgs.builder()        
            .domain("auth.example.com")
            .type("auth0_managed_certs")
            .build());

    }
}

import pulumi
import pulumi_auth0 as auth0

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

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

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

resources:
  myCustomDomain:
    type: auth0:CustomDomain
    properties:
      domain: auth.example.com
      type: auth0_managed_certs

Create CustomDomain Resource

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

@overload
def CustomDomain(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 custom_client_ip_header: Optional[str] = None,
                 domain: Optional[str] = None,
                 tls_policy: Optional[str] = None,
                 type: 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)

public CustomDomain(String name, CustomDomainArgs args)
public CustomDomain(String name, CustomDomainArgs args, CustomResourceOptions options)

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

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.

name String: The unique name of the resource.
args CustomDomainArgs: The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The CustomDomain resource accepts the following input properties:

Domain string: Name of the custom domain.
Type string: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
CustomClientIpHeader string: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
TlsPolicy string: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.

Domain string: Name of the custom domain.
Type string: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
CustomClientIpHeader string: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
TlsPolicy string: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.

domain String: Name of the custom domain.
type String: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
customClientIpHeader String: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
tlsPolicy String: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.

domain string: Name of the custom domain.
type string: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
customClientIpHeader string: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
tlsPolicy string: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.

domain str: Name of the custom domain.
type str: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
custom_client_ip_header str: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
tls_policy str: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.

domain String: Name of the custom domain.
type String: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
customClientIpHeader String: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
tlsPolicy String: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.

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.
OriginDomainName string: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
Primary bool: Indicates whether this is a primary domain.
Status string: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
Verifications List<CustomDomainVerification>: Configuration settings for verification.

Id string: The provider-assigned unique ID for this managed resource.
OriginDomainName string: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
Primary bool: Indicates whether this is a primary domain.
Status string: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
Verifications []CustomDomainVerificationType: Configuration settings for verification.

id String: The provider-assigned unique ID for this managed resource.
originDomainName String: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
primary Boolean: Indicates whether this is a primary domain.
status String: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
verifications List<CustomDomainVerification>: Configuration settings for verification.

id string: The provider-assigned unique ID for this managed resource.
originDomainName string: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
primary boolean: Indicates whether this is a primary domain.
status string: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
verifications CustomDomainVerification[]: Configuration settings for verification.

id str: The provider-assigned unique ID for this managed resource.
origin_domain_name str: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
primary bool: Indicates whether this is a primary domain.
status str: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
verifications Sequence[CustomDomainVerification]: Configuration settings for verification.

id String: The provider-assigned unique ID for this managed resource.
originDomainName String: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
primary Boolean: Indicates whether this is a primary domain.
status String: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
verifications List<Property Map>: Configuration settings for verification.

Look up 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,
        custom_client_ip_header: Optional[str] = None,
        domain: Optional[str] = None,
        origin_domain_name: Optional[str] = None,
        primary: Optional[bool] = None,
        status: Optional[str] = None,
        tls_policy: Optional[str] = None,
        type: Optional[str] = None,
        verifications: Optional[Sequence[CustomDomainVerificationArgs]] = 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)

public static CustomDomain get(String name, Output<String> id, CustomDomainState 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:

CustomClientIpHeader string: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
Domain string: Name of the custom domain.
OriginDomainName string: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
Primary bool: Indicates whether this is a primary domain.
Status string: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
TlsPolicy string: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.
Type string: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
Verifications List<CustomDomainVerificationArgs>: Configuration settings for verification.

CustomClientIpHeader string: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
Domain string: Name of the custom domain.
OriginDomainName string: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
Primary bool: Indicates whether this is a primary domain.
Status string: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
TlsPolicy string: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.
Type string: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
Verifications []CustomDomainVerificationTypeArgs: Configuration settings for verification.

customClientIpHeader String: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
domain String: Name of the custom domain.
originDomainName String: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
primary Boolean: Indicates whether this is a primary domain.
status String: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
tlsPolicy String: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.
type String: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
verifications List<CustomDomainVerificationArgs>: Configuration settings for verification.

customClientIpHeader string: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
domain string: Name of the custom domain.
originDomainName string: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
primary boolean: Indicates whether this is a primary domain.
status string: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
tlsPolicy string: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.
type string: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
verifications CustomDomainVerificationArgs[]: Configuration settings for verification.

custom_client_ip_header str: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
domain str: Name of the custom domain.
origin_domain_name str: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
primary bool: Indicates whether this is a primary domain.
status str: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
tls_policy str: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.
type str: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
verifications Sequence[CustomDomainVerificationArgs]: Configuration settings for verification.

customClientIpHeader String: The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
domain String: Name of the custom domain.
originDomainName String: Once the configuration status is ready, the DNS name of the Auth0 origin server that handles traffic for the custom domain.
primary Boolean: Indicates whether this is a primary domain.
status String: Configuration status for the custom domain. Options include disabled, pending, pending_verification, and ready.
tlsPolicy String: TLS policy for the custom domain. Available options are: compatible or recommended. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on self_managed domains.
type String: Provisioning type for the custom domain. Options include auth0_managed_certs and self_managed_certs.
verifications List<Property Map>: Configuration settings for verification.

Supporting Types

CustomDomainVerification

Methods List<object>

Methods []interface{}

methods List<Object>

methods any[]

methods Sequence[Any]

methods List<Any>

Import

Custom domains can be imported using their ID. # You can find existing custom domain IDs using the Auth0 Management API. https://auth0.com/docs/api/management/v2#!/Custom_Domains/get_custom_domains # Example

 $ pulumi import auth0:index/customDomain:CustomDomain my_custom_domain cd_XXXXXXXXXXXXXXXX

Package Details

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