@rockcarver/frodo-lib/types/api/RealmApi.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 RealmSkeleton = IdObjectSkeletonInterface & {
    parentPath: string;
    active: boolean;
    name: string;
    aliases: string[];
};
/**
 * Get all realms
 * @returns {Promise<PagedResult<RealmSkeleton>>} a promise that resolves to an object containing an array of realm objects
 */
export declare function getRealms({ state, }: {
    state: State;
}): Promise<PagedResult<RealmSkeleton>>;
/**
 * Get realm by id
 * @param {string} realmId realm id
 * @returns {Promise} a promise that resolves to an object containing a realm object
 */
export declare function getRealm({ realmId, state, }: {
    realmId: string;
    state: State;
}): Promise<RealmSkeleton>;
/**
 * Create realm
 * @param {RealmSkeleton} realmData (optional) realm data
 * @returns {Promise<RealmSkeleton>} a promise that resolves to a realm object
 */
export declare function createRealm({ realmData, state, }: {
    realmData?: RealmSkeleton;
    state: State;
}): Promise<RealmSkeleton>;
/**
 * Put realm
 * @param {string} realmId realm id
 * @param {RealmSkeleton} realmData realm config object
 * @returns {Promise<RealmSkeleton>} a promise that resolves to a realm object
 */
export declare function putRealm({ realmId, realmData, state, }: {
    realmId: string;
    realmData: RealmSkeleton;
    state: State;
}): Promise<RealmSkeleton>;
/**
 * Delete realm
 * @param {string} realmId realm id
 * @returns {Promise<RealmSkeleton>} a promise that resolves to an object containing a realm object
 */
export declare function deleteRealm({ realmId, state, }: {
    realmId: string;
    state: State;
}): Promise<RealmSkeleton>;
//# sourceMappingURL=RealmApi.d.ts.map