1. Packages
  2. Auth0 Provider
  3. API Docs
  4. getCustomDomains
Viewing docs for Auth0 v3.38.0
published on Friday, Feb 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-auth0

auth0.getCustomDomains

auth0 logo
Viewing docs for Auth0 v3.38.0
published on Friday, Feb 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-auth0

    Data source to retrieve multiple custom domains based on a search query. EA Only.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  myCustomDomain1:
    type: auth0:CustomDomain
    name: my_custom_domain_1
    properties:
      domain: example1.auth.tempdomain.com
      type: auth0_managed_certs
      tlsPolicy: recommended
      domainMetadata:
        key1: foo1
        key2: bar1
  myCustomDomain2:
    type: auth0:CustomDomain
    name: my_custom_domain_2
    properties:
      domain: example2.auth.tempdomain.com
      type: auth0_managed_certs
      tlsPolicy: recommended
      domainMetadata:
        key1: foo2
        key2: bar2
variables:
  test:
    fn::invoke:
      function: auth0:getCustomDomains
      arguments:
        q: domain:example1* AND status:pending_verification

    Using getCustomDomains

    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 getCustomDomains(args: GetCustomDomainsArgs, opts?: InvokeOptions): Promise<GetCustomDomainsResult>
function getCustomDomainsOutput(args: GetCustomDomainsOutputArgs, opts?: InvokeOptions): Output<GetCustomDomainsResult>
    def get_custom_domains(query: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCustomDomainsResult
def get_custom_domains_output(query: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCustomDomainsResult]
    func GetCustomDomains(ctx *Context, args *GetCustomDomainsArgs, opts ...InvokeOption) (*GetCustomDomainsResult, error)
func GetCustomDomainsOutput(ctx *Context, args *GetCustomDomainsOutputArgs, opts ...InvokeOption) GetCustomDomainsResultOutput

    > Note: This function is named GetCustomDomains in the Go SDK.

    public static class GetCustomDomains 
{
    public static Task<GetCustomDomainsResult> InvokeAsync(GetCustomDomainsArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomDomainsResult> Invoke(GetCustomDomainsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomDomainsResult> getCustomDomains(GetCustomDomainsArgs args, InvokeOptions options)
public static Output<GetCustomDomainsResult> getCustomDomains(GetCustomDomainsArgs args, InvokeOptions options)

    fn::invoke:
  function: auth0:index/getCustomDomains:getCustomDomains
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Query string
    Search query string to filter custom domains.
    Query string
    Search query string to filter custom domains.
    query String
    Search query string to filter custom domains.
    query string
    Search query string to filter custom domains.
    query str
    Search query string to filter custom domains.
    query String
    Search query string to filter custom domains.

    getCustomDomains Result

    The following output properties are available:

    CustomDomains List<GetCustomDomainsCustomDomain>
    List of custom domains matching the search criteria.
    Id string
    The provider-assigned unique ID for this managed resource.
    Query string
    Search query string to filter custom domains.
    CustomDomains []GetCustomDomainsCustomDomain
    List of custom domains matching the search criteria.
    Id string
    The provider-assigned unique ID for this managed resource.
    Query string
    Search query string to filter custom domains.
    customDomains List<GetCustomDomainsCustomDomain>
    List of custom domains matching the search criteria.
    id String
    The provider-assigned unique ID for this managed resource.
    query String
    Search query string to filter custom domains.
    customDomains GetCustomDomainsCustomDomain[]
    List of custom domains matching the search criteria.
    id string
    The provider-assigned unique ID for this managed resource.
    query string
    Search query string to filter custom domains.
    custom_domains Sequence[GetCustomDomainsCustomDomain]
    List of custom domains matching the search criteria.
    id str
    The provider-assigned unique ID for this managed resource.
    query str
    Search query string to filter custom domains.
    customDomains List<Property Map>
    List of custom domains matching the search criteria.
    id String
    The provider-assigned unique ID for this managed resource.
    query String
    Search query string to filter custom domains.

    Supporting Types

    GetCustomDomainsCustomDomain

    Certificates List<GetCustomDomainsCustomDomainCertificate>
    The Custom Domain certificate.
    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.
    DomainMetadata Dictionary<string, string>
    Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
    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.
    RelyingPartyIdentifier string
    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, ready and failed.
    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<GetCustomDomainsCustomDomainVerification>
    Configuration settings for verification.
    Certificates []GetCustomDomainsCustomDomainCertificate
    The Custom Domain certificate.
    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.
    DomainMetadata map[string]string
    Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
    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.
    RelyingPartyIdentifier string
    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, ready and failed.
    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 []GetCustomDomainsCustomDomainVerification
    Configuration settings for verification.
    certificates List<GetCustomDomainsCustomDomainCertificate>
    The Custom Domain certificate.
    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.
    domainMetadata Map<String,String>
    Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
    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.
    relyingPartyIdentifier String
    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, ready and failed.
    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<GetCustomDomainsCustomDomainVerification>
    Configuration settings for verification.
    certificates GetCustomDomainsCustomDomainCertificate[]
    The Custom Domain certificate.
    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.
    domainMetadata {[key: string]: string}
    Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
    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.
    relyingPartyIdentifier string
    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, ready and failed.
    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 GetCustomDomainsCustomDomainVerification[]
    Configuration settings for verification.
    certificates Sequence[GetCustomDomainsCustomDomainCertificate]
    The Custom Domain certificate.
    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.
    domain_metadata Mapping[str, str]
    Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
    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.
    relying_party_identifier str
    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, ready and failed.
    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[GetCustomDomainsCustomDomainVerification]
    Configuration settings for verification.
    certificates List<Property Map>
    The Custom Domain certificate.
    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.
    domainMetadata Map<String>
    Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only).
    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.
    relyingPartyIdentifier String
    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, ready and failed.
    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.

    GetCustomDomainsCustomDomainCertificate

    CertificateAuthority string
    Name of the certificate authority that issued the certificate.
    ErrorMsg string
    Contains the error message if the provisioning process fails.
    RenewsBefore string
    Specifies the date by which the certificate should be renewed.
    Status string
    Indicates the current state of the certificate provisioning process.
    CertificateAuthority string
    Name of the certificate authority that issued the certificate.
    ErrorMsg string
    Contains the error message if the provisioning process fails.
    RenewsBefore string
    Specifies the date by which the certificate should be renewed.
    Status string
    Indicates the current state of the certificate provisioning process.
    certificateAuthority String
    Name of the certificate authority that issued the certificate.
    errorMsg String
    Contains the error message if the provisioning process fails.
    renewsBefore String
    Specifies the date by which the certificate should be renewed.
    status String
    Indicates the current state of the certificate provisioning process.
    certificateAuthority string
    Name of the certificate authority that issued the certificate.
    errorMsg string
    Contains the error message if the provisioning process fails.
    renewsBefore string
    Specifies the date by which the certificate should be renewed.
    status string
    Indicates the current state of the certificate provisioning process.
    certificate_authority 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.
    certificateAuthority String
    Name of the certificate authority that issued the certificate.
    errorMsg String
    Contains the error message if the provisioning process fails.
    renewsBefore String
    Specifies the date by which the certificate should be renewed.
    status String
    Indicates the current state of the certificate provisioning process.

    GetCustomDomainsCustomDomainVerification

    ErrorMsg string
    Contains error message, if any, from the last DNS verification check.
    LastVerifiedAt string
    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.
    ErrorMsg string
    Contains error message, if any, from the last DNS verification check.
    LastVerifiedAt string
    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.
    errorMsg String
    Contains error message, if any, from the last DNS verification check.
    lastVerifiedAt String
    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.
    errorMsg string
    Contains error message, if any, from the last DNS verification check.
    lastVerifiedAt string
    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_at str
    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.
    errorMsg String
    Contains error message, if any, from the last DNS verification check.
    lastVerifiedAt String
    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 auth0 Terraform Provider.
    auth0 logo
    Viewing docs for Auth0 v3.38.0
    published on Friday, Feb 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-auth0
      Try Pulumi Cloud free. Your team will thank you.