Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. getCustomDomain
Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.getCustomDomain

Explore with Pulumi AI

auth0 logo
Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi
pulumi/pulumi-auth0

    Data source to retrieve the custom domain configuration.

    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(opts?: InvokeOptions): Promise<GetCustomDomainResult>
function getCustomDomainOutput(opts?: InvokeOptions): Output<GetCustomDomainResult>
    def get_custom_domain(opts: Optional[InvokeOptions] = None) -> GetCustomDomainResult
def get_custom_domain_output(opts: Optional[InvokeOptions] = None) -> Output[GetCustomDomainResult]
    func LookupCustomDomain(ctx *Context, opts ...InvokeOption) (*LookupCustomDomainResult, error)
func LookupCustomDomainOutput(ctx *Context, opts ...InvokeOption) LookupCustomDomainResultOutput

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

    public static class GetCustomDomain 
{
    public static Task<GetCustomDomainResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetCustomDomainResult> Invoke(InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomDomainResult> getCustomDomain(InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    getCustomDomain Result

    The following output properties are available:

    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.
    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.
    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<GetCustomDomainVerification>
    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.
    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.
    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 []GetCustomDomainVerificationType
    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.
    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.
    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<GetCustomDomainVerification>
    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.
    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.
    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 GetCustomDomainVerification[]
    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.
    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.
    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[GetCustomDomainVerification]
    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.
    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.
    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

    GetCustomDomainVerification

    Methods List<object>
    Verification methods for the domain.
    Methods []interface{}
    Verification methods for the domain.
    methods List<Object>
    Verification methods for the domain.
    methods any[]
    Verification methods for the domain.
    methods Sequence[Any]
    Verification methods for the domain.
    methods List<Any>
    Verification methods for the domain.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi
    pulumi/pulumi-auth0