import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"; import * as core from "../../../../core/index.js"; import * as Management from "../../../index.js"; export declare namespace CustomDomainsClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class CustomDomainsClient { protected readonly _options: NormalizedClientOptionsWithAuth; constructor(options: CustomDomainsClient.Options); /** * Retrieve details on custom domains. * * @param {Management.ListCustomDomainsRequestParameters} request * @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.UnauthorizedError} * @throws {@link Management.ForbiddenError} * @throws {@link Management.TooManyRequestsError} * * @example * await client.customDomains.list({ * q: "q", * fields: "fields", * include_fields: true, * sort: "sort" * }) */ list(request?: Management.ListCustomDomainsRequestParameters, requestOptions?: CustomDomainsClient.RequestOptions): core.HttpResponsePromise; private __list; /** * Create a new custom domain. * * Note: The custom domain will need to be verified before it will accept * requests. * * Optional attributes that can be updated: * * - custom_client_ip_header * - tls_policy * * * TLS Policies: * * - recommended - for modern usage this includes TLS 1.2 only * * @param {Management.CreateCustomDomainRequestContent} request * @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.BadRequestError} * @throws {@link Management.UnauthorizedError} * @throws {@link Management.ForbiddenError} * @throws {@link Management.ConflictError} * @throws {@link Management.TooManyRequestsError} * * @example * await client.customDomains.create({ * domain: "domain", * type: "auth0_managed_certs" * }) */ create(request: Management.CreateCustomDomainRequestContent, requestOptions?: CustomDomainsClient.RequestOptions): core.HttpResponsePromise; private __create; /** * Retrieve the tenant's default domain. * * @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.UnauthorizedError} * @throws {@link Management.ForbiddenError} * @throws {@link Management.TooManyRequestsError} * * @example * await client.customDomains.getDefault() */ getDefault(requestOptions?: CustomDomainsClient.RequestOptions): core.HttpResponsePromise; private __getDefault; /** * Set the default custom domain for the tenant. * * @param {Management.SetDefaultCustomDomainRequestContent} request * @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.BadRequestError} * @throws {@link Management.ForbiddenError} * * @example * await client.customDomains.setDefault({ * domain: "domain" * }) */ setDefault(request: Management.SetDefaultCustomDomainRequestContent, requestOptions?: CustomDomainsClient.RequestOptions): core.HttpResponsePromise; private __setDefault; /** * Retrieve a custom domain configuration and status. * * @param {string} id - ID of the custom domain to retrieve. * @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.BadRequestError} * @throws {@link Management.UnauthorizedError} * @throws {@link Management.ForbiddenError} * @throws {@link Management.NotFoundError} * @throws {@link Management.TooManyRequestsError} * * @example * await client.customDomains.get("id") */ get(id: string, requestOptions?: CustomDomainsClient.RequestOptions): core.HttpResponsePromise; private __get; /** * Delete a custom domain and stop serving requests for it. * * @param {string} id - ID of the custom domain to delete. * @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.BadRequestError} * @throws {@link Management.UnauthorizedError} * @throws {@link Management.ForbiddenError} * @throws {@link Management.TooManyRequestsError} * * @example * await client.customDomains.delete("id") */ delete(id: string, requestOptions?: CustomDomainsClient.RequestOptions): core.HttpResponsePromise; private __delete; /** * Update a custom domain. * * These are the attributes that can be updated: * * - custom_client_ip_header * - tls_policy * *
Updating CUSTOM_CLIENT_IP_HEADER for a custom domain
To update the custom_client_ip_header for a domain, the body to * send should be: *
{ "custom_client_ip_header": "cf-connecting-ip" }
* *
Updating TLS_POLICY for a custom domain
To update the tls_policy for a domain, the body to send should be: *
{ "tls_policy": "recommended" }
* * * TLS Policies: * * - recommended - for modern usage this includes TLS 1.2 only * * * Some considerations: * * - The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally. * - The compatible TLS policy is no longer supported. * * @param {string} id - The id of the custom domain to update * @param {Management.UpdateCustomDomainRequestContent} request * @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.BadRequestError} * @throws {@link Management.UnauthorizedError} * @throws {@link Management.ForbiddenError} * @throws {@link Management.TooManyRequestsError} * * @example * await client.customDomains.update("id") */ update(id: string, request?: Management.UpdateCustomDomainRequestContent, requestOptions?: CustomDomainsClient.RequestOptions): core.HttpResponsePromise; private __update; /** * Run the test process on a custom domain. * * @param {string} id - ID of the custom domain to test. * @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.BadRequestError} * @throws {@link Management.UnauthorizedError} * @throws {@link Management.ForbiddenError} * @throws {@link Management.NotFoundError} * @throws {@link Management.ConflictError} * * @example * await client.customDomains.test("id") */ test(id: string, requestOptions?: CustomDomainsClient.RequestOptions): core.HttpResponsePromise; private __test; /** * Run the verification process on a custom domain. * * Note: Check the status field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests. * * For self_managed_certs, when the custom domain is verified for the first time, the response will also include the cname_api_key which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests. * * Learn more about verifying custom domains that use Auth0 Managed certificates. * Learn more about verifying custom domains that use Self Managed certificates. * * @param {string} id - ID of the custom domain to verify. * @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.BadRequestError} * @throws {@link Management.UnauthorizedError} * @throws {@link Management.ForbiddenError} * @throws {@link Management.NotFoundError} * @throws {@link Management.TooManyRequestsError} * * @example * await client.customDomains.verify("id") */ verify(id: string, requestOptions?: CustomDomainsClient.RequestOptions): core.HttpResponsePromise; private __verify; }