@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
51 lines • 1.76 kB
TypeScript
import { State } from '../shared/State';
import { type NoIdObjectSkeletonInterface } from './ApiTypes';
export type PolicySetSkeleton = NoIdObjectSkeletonInterface & {
name: string;
resourceTypeUuids: string[];
};
/**
* Get all policy sets
* @returns {Promise} a promise that resolves to an object containing an array of policy set objects
*/
export declare function getPolicySets({ state }: {
state: State;
}): Promise<any>;
/**
* Get policy set
* @param {string} policySetName policy set name
* @returns {Promise<PolicySetSkeleton>} a promise that resolves to an object containing an array of policy set objects
*/
export declare function getPolicySet({ policySetName, state, }: {
policySetName: string;
state: State;
}): Promise<PolicySetSkeleton>;
/**
* Create a policy set
* @param {Object} policySetData Object representing an policy set
* @returns {Promise} a promise that resolves to a policy set object
*/
export declare function createPolicySet({ policySetData, state, }: {
policySetData: PolicySetSkeleton;
state: State;
}): Promise<any>;
/**
* Update policy set
* @param {Object} policySetData Object representing a policy set
* @returns {Promise} a promise that resolves to a policy set object
*/
export declare function updatePolicySet({ policySetName, policySetData, state, }: {
policySetName?: string;
policySetData: PolicySetSkeleton;
state: State;
}): Promise<any>;
/**
* Delete policy set
* @param {Object} policySetName policy set name
* @returns {Promise} a promise that resolves to a policy set object
*/
export declare function deletePolicySet({ policySetName, state, }: {
policySetName: string;
state: State;
}): Promise<any>;
//# sourceMappingURL=PolicySetApi.d.ts.map