Back to Node Auth0

Interface CustomDomain

docs/interfaces/management.Management.CustomDomain.html

5.9.13.6 KB
Original Source

Interface CustomDomain

interface CustomDomain {
custom_domain_id: string;
domain: string;
primary: boolean;
is_default?: boolean;
status: Management.CustomDomainStatusFilterEnum;
type: Management.CustomDomainTypeEnum;
origin_domain_name?: string;
verification?: DomainVerification;
custom_client_ip_header?: string | null;
tls_policy?: string;
domain_metadata?: DomainMetadata;
certificate?: DomainCertificate;
relying_party_identifier?: string;
}

Index

Properties

custom_domain_iddomainprimaryis_default?statustypeorigin_domain_name?verification?custom_client_ip_header?tls_policy?domain_metadata?certificate?relying_party_identifier?

Properties

custom_domain_id

custom_domain_id: string

ID of the custom domain.

domain

domain: string

Domain name.

primary

primary: boolean

Whether this is a primary domain (true) or not (false).

Optionalis_default

is_default?: boolean

Whether this is the default custom domain (true) or not (false).

status

status: Management.CustomDomainStatusFilterEnum

type

type: Management.CustomDomainTypeEnum

Optionalorigin_domain_name

origin_domain_name?: string

Intermediate address.

Optionalverification

verification?: DomainVerification

Optionalcustom_client_ip_header

custom_client_ip_header?: string | null

The HTTP header to fetch the client's IP address

Optionaltls_policy

tls_policy?: string

The TLS version policy

Optionaldomain_metadata

domain_metadata?: DomainMetadata

Optionalcertificate

certificate?: DomainCertificate

Optionalrelying_party_identifier

relying_party_identifier?: string

Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used.

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties custom_domain_iddomainprimaryis_defaultstatustypeorigin_domain_nameverificationcustom_client_ip_headertls_policydomain_metadatacertificaterelying_party_identifier