UNPKG

@rockcarver/frodo-lib

Version:

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

31 lines 1.4 kB
import { State } from '../shared/State'; import { type IdObjectSkeletonInterface } from './ApiTypes'; export type AuthenticationSettingsSkeleton = IdObjectSkeletonInterface & { _id: ''; _type: { _id: 'EMPTY'; name: 'Core'; collection: false; }; }; /** * Get authentication settings * @param {boolean} globalConfig true if global authentication settings are the target of the operation, false otherwise. Default: false. * @returns {Promise<AuthenticationSettingsSkeleton>} a promise that resolves to an authentication settings object */ export declare function getAuthenticationSettings({ state, globalConfig, }: { state: State; globalConfig: boolean; }): Promise<AuthenticationSettingsSkeleton>; /** * Put authentication settings * @param {AuthenticationSettingsSkeleton} settings authentication settings object * @param {boolean} globalConfig true if global authentication settings are the target of the operation, false otherwise. Default: false. * @returns {Promise<AuthenticationSettingsSkeleton>} a promise that resolves to an authentiction settings object */ export declare function putAuthenticationSettings({ settings, globalConfig, state, }: { settings: AuthenticationSettingsSkeleton; globalConfig: boolean; state: State; }): Promise<AuthenticationSettingsSkeleton>; //# sourceMappingURL=AuthenticationSettingsApi.d.ts.map