Viewing docs for Auth0 v3.38.0
published on Friday, Feb 20, 2026 by Pulumi
published on Friday, Feb 20, 2026 by Pulumi
Viewing docs for Auth0 v3.38.0
published on Friday, Feb 20, 2026 by Pulumi
published on Friday, Feb 20, 2026 by Pulumi
Data source to retrieve the custom domain configuration.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";
const myCustomDomain = new auth0.CustomDomain("my_custom_domain", {
domain: "example.auth.tempdomain.com",
type: "auth0_managed_certs",
tlsPolicy: "recommended",
domainMetadata: {
key1: "value1",
key2: "value2",
},
});
const test = auth0.getCustomDomainOutput({
customDomainId: myCustomDomain.id,
});
import pulumi
import pulumi_auth0 as auth0
my_custom_domain = auth0.CustomDomain("my_custom_domain",
domain="example.auth.tempdomain.com",
type="auth0_managed_certs",
tls_policy="recommended",
domain_metadata={
"key1": "value1",
"key2": "value2",
})
test = auth0.get_custom_domain_output(custom_domain_id=my_custom_domain.id)
package main
import (
"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
myCustomDomain, err := auth0.NewCustomDomain(ctx, "my_custom_domain", &auth0.CustomDomainArgs{
Domain: pulumi.String("example.auth.tempdomain.com"),
Type: pulumi.String("auth0_managed_certs"),
TlsPolicy: pulumi.String("recommended"),
DomainMetadata: pulumi.StringMap{
"key1": pulumi.String("value1"),
"key2": pulumi.String("value2"),
},
})
if err != nil {
return err
}
_ = auth0.LookupCustomDomainOutput(ctx, auth0.GetCustomDomainOutputArgs{
CustomDomainId: myCustomDomain.ID(),
}, nil)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;
return await Deployment.RunAsync(() =>
{
var myCustomDomain = new Auth0.CustomDomain("my_custom_domain", new()
{
Domain = "example.auth.tempdomain.com",
Type = "auth0_managed_certs",
TlsPolicy = "recommended",
DomainMetadata =
{
{ "key1", "value1" },
{ "key2", "value2" },
},
});
var test = Auth0.GetCustomDomain.Invoke(new()
{
CustomDomainId = myCustomDomain.Id,
});
});
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 com.pulumi.auth0.Auth0Functions;
import com.pulumi.auth0.inputs.GetCustomDomainArgs;
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("example.auth.tempdomain.com")
.type("auth0_managed_certs")
.tlsPolicy("recommended")
.domainMetadata(Map.ofEntries(
Map.entry("key1", "value1"),
Map.entry("key2", "value2")
))
.build());
final var test = Auth0Functions.getCustomDomain(GetCustomDomainArgs.builder()
.customDomainId(myCustomDomain.id())
.build());
}
}
resources:
myCustomDomain:
type: auth0:CustomDomain
name: my_custom_domain
properties:
domain: example.auth.tempdomain.com
type: auth0_managed_certs
tlsPolicy: recommended
domainMetadata:
key1: value1
key2: value2
variables:
test:
fn::invoke:
function: auth0:getCustomDomain
arguments:
customDomainId: ${myCustomDomain.id}
Using getCustomDomain
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCustomDomain(args: GetCustomDomainArgs, opts?: InvokeOptions): Promise<GetCustomDomainResult>
function getCustomDomainOutput(args: GetCustomDomainOutputArgs, opts?: InvokeOptions): Output<GetCustomDomainResult>def get_custom_domain(custom_domain_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCustomDomainResult
def get_custom_domain_output(custom_domain_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCustomDomainResult]func LookupCustomDomain(ctx *Context, args *LookupCustomDomainArgs, opts ...InvokeOption) (*LookupCustomDomainResult, error)
func LookupCustomDomainOutput(ctx *Context, args *LookupCustomDomainOutputArgs, opts ...InvokeOption) LookupCustomDomainResultOutput> Note: This function is named LookupCustomDomain in the Go SDK.
public static class GetCustomDomain
{
public static Task<GetCustomDomainResult> InvokeAsync(GetCustomDomainArgs args, InvokeOptions? opts = null)
public static Output<GetCustomDomainResult> Invoke(GetCustomDomainInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCustomDomainResult> getCustomDomain(GetCustomDomainArgs args, InvokeOptions options)
public static Output<GetCustomDomainResult> getCustomDomain(GetCustomDomainArgs args, InvokeOptions options)
fn::invoke:
function: auth0:index/getCustomDomain:getCustomDomain
arguments:
# arguments dictionaryThe following arguments are supported:
- Custom
Domain stringId - The ID of the Custom Domain.
- Custom
Domain stringId - The ID of the Custom Domain.
- custom
Domain StringId - The ID of the Custom Domain.
- custom
Domain stringId - The ID of the Custom Domain.
- custom_
domain_ strid - The ID of the Custom Domain.
- custom
Domain StringId - The ID of the Custom Domain.
getCustomDomain Result
The following output properties are available:
- Certificates
List<Get
Custom Domain Certificate> - The Custom Domain certificate.
- Custom
Client stringIp Header - The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
- Domain string
- Name of the custom domain.
- Domain
Metadata Dictionary<string, string> - Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
- Id string
- The provider-assigned unique ID for this managed resource.
- Origin
Domain stringName - 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.
- Relying
Party stringIdentifier - Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided or set to null, the full domain will be used.
- Status string
- Configuration status for the custom domain. Options include
disabled,pending,pending_verification,readyandfailed. - Tls
Policy string - TLS policy for the custom domain. Available options are:
compatibleorrecommended. 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_certsandself_managed_certs. - Verifications
List<Get
Custom Domain Verification> - Configuration settings for verification.
- Custom
Domain stringId - The ID of the Custom Domain.
- Certificates
[]Get
Custom Domain Certificate - The Custom Domain certificate.
- Custom
Client stringIp Header - The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
- Domain string
- Name of the custom domain.
- Domain
Metadata map[string]string - Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
- Id string
- The provider-assigned unique ID for this managed resource.
- Origin
Domain stringName - 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.
- Relying
Party stringIdentifier - Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided or set to null, the full domain will be used.
- Status string
- Configuration status for the custom domain. Options include
disabled,pending,pending_verification,readyandfailed. - Tls
Policy string - TLS policy for the custom domain. Available options are:
compatibleorrecommended. 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_certsandself_managed_certs. - Verifications
[]Get
Custom Domain Verification Type - Configuration settings for verification.
- Custom
Domain stringId - The ID of the Custom Domain.
- certificates
List<Get
Custom Domain Certificate> - The Custom Domain certificate.
- custom
Client StringIp Header - The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
- domain String
- Name of the custom domain.
- domain
Metadata Map<String,String> - Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
- id String
- The provider-assigned unique ID for this managed resource.
- origin
Domain StringName - 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.
- relying
Party StringIdentifier - Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided or set to null, the full domain will be used.
- status String
- Configuration status for the custom domain. Options include
disabled,pending,pending_verification,readyandfailed. - tls
Policy String - TLS policy for the custom domain. Available options are:
compatibleorrecommended. 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_certsandself_managed_certs. - verifications
List<Get
Custom Domain Verification> - Configuration settings for verification.
- custom
Domain StringId - The ID of the Custom Domain.
- certificates
Get
Custom Domain Certificate[] - The Custom Domain certificate.
- custom
Client stringIp Header - The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
- domain string
- Name of the custom domain.
- domain
Metadata {[key: string]: string} - Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
- id string
- The provider-assigned unique ID for this managed resource.
- origin
Domain stringName - 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.
- relying
Party stringIdentifier - Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided or set to null, the full domain will be used.
- status string
- Configuration status for the custom domain. Options include
disabled,pending,pending_verification,readyandfailed. - tls
Policy string - TLS policy for the custom domain. Available options are:
compatibleorrecommended. 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_certsandself_managed_certs. - verifications
Get
Custom Domain Verification[] - Configuration settings for verification.
- custom
Domain stringId - The ID of the Custom Domain.
- certificates
Sequence[Get
Custom Domain Certificate] - The Custom Domain certificate.
- custom_
client_ strip_ header - The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
- domain str
- Name of the custom domain.
- domain_
metadata Mapping[str, str] - Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
- id str
- The provider-assigned unique ID for this managed resource.
- origin_
domain_ strname - 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.
- relying_
party_ stridentifier - Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided or set to null, the full domain will be used.
- status str
- Configuration status for the custom domain. Options include
disabled,pending,pending_verification,readyandfailed. - tls_
policy str - TLS policy for the custom domain. Available options are:
compatibleorrecommended. 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_certsandself_managed_certs. - verifications
Sequence[Get
Custom Domain Verification] - Configuration settings for verification.
- custom_
domain_ strid - The ID of the Custom Domain.
- certificates List<Property Map>
- The Custom Domain certificate.
- custom
Client StringIp Header - The HTTP header to fetch the client's IP address. Cannot be set on auth0_managed domains.
- domain String
- Name of the custom domain.
- domain
Metadata Map<String> - Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
- id String
- The provider-assigned unique ID for this managed resource.
- origin
Domain StringName - 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.
- relying
Party StringIdentifier - Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided or set to null, the full domain will be used.
- status String
- Configuration status for the custom domain. Options include
disabled,pending,pending_verification,readyandfailed. - tls
Policy String - TLS policy for the custom domain. Available options are:
compatibleorrecommended. 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_certsandself_managed_certs. - verifications List<Property Map>
- Configuration settings for verification.
- custom
Domain StringId - The ID of the Custom Domain.
Supporting Types
GetCustomDomainCertificate
- string
- Name of the certificate authority that issued the certificate.
- Error
Msg string - Contains the error message if the provisioning process fails.
- Renews
Before string - Specifies the date by which the certificate should be renewed.
- Status string
- Indicates the current state of the certificate provisioning process.
- string
- Name of the certificate authority that issued the certificate.
- Error
Msg string - Contains the error message if the provisioning process fails.
- Renews
Before string - Specifies the date by which the certificate should be renewed.
- Status string
- Indicates the current state of the certificate provisioning process.
- String
- Name of the certificate authority that issued the certificate.
- error
Msg String - Contains the error message if the provisioning process fails.
- renews
Before String - Specifies the date by which the certificate should be renewed.
- status String
- Indicates the current state of the certificate provisioning process.
- string
- Name of the certificate authority that issued the certificate.
- error
Msg string - Contains the error message if the provisioning process fails.
- renews
Before string - Specifies the date by which the certificate should be renewed.
- status string
- Indicates the current state of the certificate provisioning process.
- str
- Name of the certificate authority that issued the certificate.
- error_
msg str - Contains the error message if the provisioning process fails.
- renews_
before str - Specifies the date by which the certificate should be renewed.
- status str
- Indicates the current state of the certificate provisioning process.
- String
- Name of the certificate authority that issued the certificate.
- error
Msg String - Contains the error message if the provisioning process fails.
- renews
Before String - Specifies the date by which the certificate should be renewed.
- status String
- Indicates the current state of the certificate provisioning process.
GetCustomDomainVerification
- Error
Msg string - Contains error message, if any, from the last DNS verification check.
- Last
Verified stringAt - Indicates the last time the domain was successfully verified.
- Methods List<object>
- Defines the list of domain verification methods used.
- Status string
- Represents the current status of the domain verification process.
- Error
Msg string - Contains error message, if any, from the last DNS verification check.
- Last
Verified stringAt - Indicates the last time the domain was successfully verified.
- Methods []interface{}
- Defines the list of domain verification methods used.
- Status string
- Represents the current status of the domain verification process.
- error
Msg String - Contains error message, if any, from the last DNS verification check.
- last
Verified StringAt - Indicates the last time the domain was successfully verified.
- methods List<Object>
- Defines the list of domain verification methods used.
- status String
- Represents the current status of the domain verification process.
- error
Msg string - Contains error message, if any, from the last DNS verification check.
- last
Verified stringAt - Indicates the last time the domain was successfully verified.
- methods any[]
- Defines the list of domain verification methods used.
- status string
- Represents the current status of the domain verification process.
- error_
msg str - Contains error message, if any, from the last DNS verification check.
- last_
verified_ strat - Indicates the last time the domain was successfully verified.
- methods Sequence[Any]
- Defines the list of domain verification methods used.
- status str
- Represents the current status of the domain verification process.
- error
Msg String - Contains error message, if any, from the last DNS verification check.
- last
Verified StringAt - Indicates the last time the domain was successfully verified.
- methods List<Any>
- Defines the list of domain verification methods used.
- status String
- Represents the current status of the domain verification process.
Package Details
- Repository
- Auth0 pulumi/pulumi-auth0
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
auth0Terraform Provider.
Viewing docs for Auth0 v3.38.0
published on Friday, Feb 20, 2026 by Pulumi
published on Friday, Feb 20, 2026 by Pulumi
