@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
28 lines • 1.04 kB
TypeScript
import { EnvInfoInterface } from '../api/cloud/EnvInfoApi';
import { State } from '../shared/State';
export type Info = {
/**
* Get info about the platform instance
* @returns {Promise<PlatformInfo>} a promise that resolves to a json blob with information about the instance and tokens
*/
getInfo(): Promise<PlatformInfo>;
};
declare const _default: (state: State) => Info;
export default _default;
export interface PlatformInfoInterface {
host: string;
authenticatedSubject: string;
amVersion: string;
cookieName: string;
sessionToken: string;
bearerToken?: string;
deploymentType: string;
}
export type PlatformInfo = PlatformInfoInterface & Partial<EnvInfoInterface>;
/**
* Get info about the platform instance
* @param {State} state library state
* @returns {Promise<PlatformInfo>} a promise that resolves to a json blob with information about the instance and tokens
*/
export declare function getInfo(state: State): Promise<PlatformInfo>;
//# sourceMappingURL=InfoOps.d.ts.map