@rockcarver/frodo-lib/types/api/classic/SiteApi.d.ts

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

import { State } from '../../shared/State';
import { IdObjectSkeletonInterface, PagedResult } from '../ApiTypes';
export type SiteSkeleton = IdObjectSkeletonInterface & {
    id: string;
    url: string;
    secondaryURLs: string[];
    servers: {
        id: string;
        url: string;
    }[];
};
/**
 * Get site
 * @param {string} siteId Site id
 * @returns {Promise<SiteSkeleton>} a promise that resolves to a site object
 */
export declare function getSite({ siteId, state, }: {
    siteId: string;
    state: State;
}): Promise<SiteSkeleton>;
/**
 * Get all sites
 * @returns {Promise<PagedResult<SiteSkeleton[]>>} a promise that resolves to an array of site objects
 */
export declare function getSites({ state, }: {
    state: State;
}): Promise<PagedResult<SiteSkeleton>>;
/**
 * Put site
 * @param {string} siteId site id
 * @param {SiteSkeleton} siteData site config object
 * @returns {Promise<SiteSkeleton>} a promise that resolves to a site object
 */
export declare function putSite({ siteId, siteData, state, }: {
    siteId: string;
    siteData: SiteSkeleton;
    state: State;
}): Promise<SiteSkeleton>;
//# sourceMappingURL=SiteApi.d.ts.map