@rockcarver/frodo-lib/types/ops/cloud/EnvCustomDomainsOps.d.ts

A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.

import { CustomDomains } from '../../api/cloud/EnvCustomDomainsApi';
import { State } from '../../shared/State';
export type EnvCustomDomains = {
    /**
     * Verify CNAME
     * @param {string} name CNAME to verify
     * @returns {Promise<boolean>} a promise that resolves to true if successul, false otherwise.
     */
    verifyCNAME(name: string): Promise<boolean>;
    /**
     * Read custom domains
     * @returns {Promise<CustomDomains>} a promise that resolves to a CustomDomains object
     */
    readCustomDomains(): Promise<CustomDomains>;
    /**
     * Update custom domains
     * @param {CustomDomains} domains CustomDomains object
     * @returns {Promise<CustomDomains>} a promise that resolves to a CustomDomains object.
     */
    updateCustomDomains(domains: CustomDomains): Promise<CustomDomains>;
};
declare const _default: (state: State) => EnvCustomDomains;
export default _default;
/**
 * Verify CNAME
 * @param {Object} params Parameters object.
 * @param {string} params.name CNAME to verify
 * @param {State} params.state State object.
 * @returns {Promise<boolean>} a promise that resolves to true if successul, false otherwise.
 */
export declare function verifyCNAME({ name, state, }: {
    name: string;
    state: State;
}): Promise<boolean>;
/**
 * Read custom domains
 * @returns {Promise<CustomDomains>} a promise that resolves to a CustomDomains object
 */
export declare function readCustomDomains({ state, }: {
    state: State;
}): Promise<CustomDomains>;
/**
 * Update custom domains
 * @param {Object} params Parameters object.
 * @param {CustomDomains} params.domains CustomDomains object
 * @param {State} params.state State object.
 * @returns {Promise<CustomDomains>} a promise that resolves to a CustomDomains object.
 */
export declare function updateCustomDomains({ domains, state, }: {
    domains: CustomDomains;
    state: State;
}): Promise<CustomDomains>;
//# sourceMappingURL=EnvCustomDomainsOps.d.ts.map