@rockcarver/frodo-lib/types/api/CirclesOfTrustApi.d.ts

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

import { State } from '../shared/State';
import { type AmConfigEntityInterface, type PagedResult } from './ApiTypes';
export type CircleOfTrustSkeleton = AmConfigEntityInterface & {
    status?: string;
    trustedProviders?: string[];
};
/**
 * Get all circles of trust
 * @returns {Promise<PagedResult<CircleOfTrustSkeleton>>} a promise that resolves to an array of circles of trust objects
 */
export declare function getCirclesOfTrust({ state, }: {
    state: State;
}): Promise<PagedResult<CircleOfTrustSkeleton>>;
/**
 * Get circle of trust by id/name
 * @param {string} cotId circle of trust id/name
 * @returns {Promise<CircleOfTrustSkeleton>} a promise that resolves to a saml2 circle of trust object
 */
export declare function getCircleOfTrust({ cotId, state, }: {
    cotId: string;
    state: State;
}): Promise<CircleOfTrustSkeleton>;
/**
 * Create a circle of trust
 * @param {CircleOfTrustSkeleton} cotData Object representing a SAML circle of trust
 * @returns {Promise<CircleOfTrustSkeleton>} a promise that resolves to a saml2 circle of trust object
 */
export declare function createCircleOfTrust({ cotData, state, }: {
    cotData: CircleOfTrustSkeleton;
    state: State;
}): Promise<CircleOfTrustSkeleton>;
/**
 * Update circle of trust
 * @param {string} cotId circle of trust id/name
 * @param {CircleOfTrustSkeleton} cotData Object representing a circle of trust
 * @returns {Promise<CircleOfTrustSkeleton>} a promise that resolves to a saml2 circle of trust object
 */
export declare function updateCircleOfTrust({ cotId, cotData, state, }: {
    cotId: string;
    cotData: CircleOfTrustSkeleton;
    state: State;
}): Promise<CircleOfTrustSkeleton>;
/**
 * Delete circle of trust
 * @param {string} realmId realm id
 * @returns {Promise<CircleOfTrustSkeleton>} a promise that resolves to an object containing a realm object
 */
export declare function deleteCircleOfTrust({ cotId, state, }: {
    cotId: string;
    state: State;
}): Promise<CircleOfTrustSkeleton>;
//# sourceMappingURL=CirclesOfTrustApi.d.ts.map