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

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

import { State } from '../../shared/State';
import { AmConfigEntityInterface, IdObjectSkeletonInterface, PagedResult } from '../ApiTypes';
export type SecretStoreSkeleton = AmConfigEntityInterface;
export type SecretStoreMappingSkeleton = IdObjectSkeletonInterface & {
    secretId: string;
    aliases: string[];
};
/**
 * Get all secret stores
 * @param {boolean} globalConfig true if the secret store is global, false otherwise. Default: false.
 * @returns {Promise<PagedResult<SecretStoreSkeleton>>} a promise that resolves to an array of secret store objects
 */
export declare function getSecretStores({ globalConfig, state, }: {
    globalConfig: boolean;
    state: State;
}): Promise<PagedResult<SecretStoreSkeleton>>;
/**
 * Get secret store mappings
 * @param {string} secretStoreId Secret store id
 * @param {string} secretStoreTypeId Secret store type id
 * @param {boolean} globalConfig true if the secret store is global, false otherwise. Default: false.
 * @returns {Promise<SecretStoreMappingSkeleton[]>} a promise that resolves to an array of secret store mapping objects
 */
export declare function getSecretStoreMappings({ secretStoreId, secretStoreTypeId, globalConfig, state, }: {
    secretStoreId: string;
    secretStoreTypeId: string;
    globalConfig: boolean;
    state: State;
}): Promise<PagedResult<SecretStoreMappingSkeleton>>;
/**
 * Put secret store
 * @param {SecretStoreSkeleton} secretStoreData secret store to import
 * @param {boolean} globalConfig true if the secret store is global, false otherwise. Default: false.
 * @returns {Promise<SecretStoreSkeleton>} a promise that resolves to a secret store object
 */
export declare function putSecretStore({ secretStoreData, globalConfig, state, }: {
    secretStoreData: SecretStoreSkeleton;
    globalConfig: boolean;
    state: State;
}): Promise<SecretStoreSkeleton>;
/**
 * Put secret store mapping
 * @param {string} secretStoreId Secret store id
 * @param {string} secretStoreTypeId Secret store type id
 * @param {SecretStoreMappingSkeleton} secretStoreMappingData secret store mapping to import
 * @param {boolean} globalConfig true if the secret store mapping is global, false otherwise. Default: false.
 * @returns {Promise<SecretStoreMappingSkeleton>} a promise that resolves to a secret store mapping object
 */
export declare function putSecretStoreMapping({ secretStoreId, secretStoreTypeId, secretStoreMappingData, globalConfig, state, }: {
    secretStoreId: string;
    secretStoreTypeId: string;
    secretStoreMappingData: SecretStoreMappingSkeleton;
    globalConfig: boolean;
    state: State;
}): Promise<SecretStoreMappingSkeleton>;
//# sourceMappingURL=SecretStoreApi.d.ts.map