@rockcarver/frodo-lib

Version:

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

1 lines • 181 kB

HTML

<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>State | Frodo Library - v3.1.0</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Frodo Library - v3.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Frodo Library</a></li><li><a href="../modules/Reference.html">Reference</a></li><li><a href="Reference.State.html">State</a></li></ul><h1>Type Alias State</h1></div><div class="tsd-signature">State: { getAdminClientId(): string; getAdminClientRedirectUri(): string; getAllowInsecureConnection(): boolean; getAmVersion(): string; getAuthenticationHeaderOverrides(): Record<string, string>; getAuthenticationService(): string; getAutoRefreshTimer(): Timeout; getAxiosRetryConfig(): IAxiosRetryConfig; getBearerToken(): string; getBearerTokenMeta(): <a href="Reference.AccessTokenMetaType.html" class="tsd-signature-type tsd-kind-type-alias">AccessTokenMetaType</a>; getConnectionProfilesPath(): string; getCookieName(): string; getCookieValue(): string; getCreateProgressHandler(): ( type: <a href="Reference.ProgressIndicatorType.html" class="tsd-signature-type tsd-kind-type-alias">ProgressIndicatorType</a>, total?: number, message?: string, ) => string; getCurlirize(): boolean; getCurlirizeHandler(): (message: string) => void; getDebug(): boolean; getDebugHandler(): (message: string | object) => void; getDeploymentType(): string; getDirectory(): string; getErrorHandler(): (error: Error, message?: string) => void; getFeatures(): <a href="../interfaces/Reference.FeatureInterface.html" class="tsd-signature-type tsd-kind-interface">FeatureInterface</a>[]; getFrodoVersion(): string; getHost(): string; getIdmHost(): string; getLogApiKey(): string; getLogApiSecret(): string; getMasterKeyPath(): string; getOutputFile(): string; getPassword(): string; getPrintHandler(): ( message: string | object, type?: string, newline?: boolean, ) => void; getRealm(): string; getServiceAccountId(): string; getServiceAccountJwk(): <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>; getServiceAccountScope(): string; getState(): <a href="../interfaces/Reference.StateInterface.html" class="tsd-signature-type tsd-kind-interface">StateInterface</a>; getStopProgressHandler(): ( id: string, message: string, status?: <a href="Reference.ProgressIndicatorStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ProgressIndicatorStatusType</a>, ) => void; getTenant(): string; getTokenCachePath(): string; getUpdateProgressHandler(): (id: string, message: string) => void; getUseBearerTokenForAmApis(): boolean; getUsername(): string; getUserSessionTokenMeta(): <a href="Reference.UserSessionMetaType.html" class="tsd-signature-type tsd-kind-type-alias">UserSessionMetaType</a>; getUseTokenCache(): boolean; getVerbose(): boolean; getVerboseHandler(): (message: string | object) => void; reset(): void; setAdminClientId(type: string): void; setAdminClientRedirectUri(type: string): void; setAllowInsecureConnection(allowInsecureConnection: boolean): void; setAmVersion(version: string): void; setAuthenticationHeaderOverrides(overrides: Record<string, string>): void; setAuthenticationService(service: string): void; setAutoRefreshTimer(timer: Timeout): void; setAxiosRetryConfig(axiosRetryConfig: IAxiosRetryConfig): void; setBearerTokenMeta(token: <a href="Reference.AccessTokenMetaType.html" class="tsd-signature-type tsd-kind-type-alias">AccessTokenMetaType</a>): void; setConnectionProfilesPath(path: string): void; setCookieName(name: string): void; setCreateProgressHandler( handler: ( type: <a href="Reference.ProgressIndicatorType.html" class="tsd-signature-type tsd-kind-type-alias">ProgressIndicatorType</a>, total?: number, message?: string, ) => string, ): void; setCurlirize(curlirize: boolean): void; setCurlirizeHandler(handler: (message: string) => void): void; setDebug(debug: boolean): void; setDebugHandler(handler: (message: string | object) => void): void; setDeploymentType(type: string): void; setDirectory(directory: string): void; setErrorHandler(handler: (error: Error, message?: string) => void): void; setFeatures(features: <a href="../interfaces/Reference.FeatureInterface.html" class="tsd-signature-type tsd-kind-interface">FeatureInterface</a>[]): void; setFrodoVersion(version: string): void; setHost(host: string): void; setIdmHost(host: string): void; setLogApiKey(key: string): void; setLogApiSecret(secret: string): void; setMasterKeyPath(path: string): void; setOutputFile(file: string): void; setPassword(password: string): void; setPrintHandler( handler: ( message: string | object, type?: string, newline?: boolean, ) => void, ): void; setRealm(realm: string): void; setServiceAccountId(uuid: string): void; setServiceAccountJwk(jwk: <a href="Reference.JwkRsa.html" class="tsd-signature-type tsd-kind-type-alias">JwkRsa</a>): void; setServiceAccountScope(scope: string): void; setStopProgressHandler( handler: ( id: string, message: string, status?: <a href="Reference.ProgressIndicatorStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ProgressIndicatorStatusType</a>, ) => void, ): void; setTenant(tenant: string): void; setTokenCachePath(path: string): void; setUpdateProgressHandler( handler: (id: string, message: string) => void, ): void; setUseBearerTokenForAmApis(useBearerTokenForAmApis: boolean): void; setUsername(username: string): void; setUserSessionTokenMeta(value: <a href="Reference.UserSessionMetaType.html" class="tsd-signature-type tsd-kind-type-alias">UserSessionMetaType</a>): void; setUseTokenCache(useTokenCache: boolean): void; setVerbose(verbose: boolean): void; setVerboseHandler(handler: (message: string | object) => void): void; }</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>getAdminClientId<a id="__typegetadminclientid" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegetadminclientid-1" class="tsd-anchor"></a>getAdminClientId(): string<a href="#__typegetadminclientid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns string</h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/shared/State.ts#L51">shared/State.ts:51</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>getAdminClientRedirectUri<a id="__typegetadminclientredirecturi" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegetadminclientredirecturi-1" class="tsd-anchor"></a>getAdminClientRedirectUri(): string<a href="#__typegetadminclientredirecturi-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns string</h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/shared/State.ts#L53">shared/State.ts:53</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>getAllowInsecureConnection<a id="__typegetallowinsecureconnection" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegetallowinsecureconnection-1" class="tsd-anchor"></a>getAllowInsecureConnection(): boolean<a href="#__typegetallowinsecureconnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns boolean</h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/shared/State.ts#L55">shared/State.ts:55</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>getAmVersion<a id="__typegetamversion" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegetamversion-1" class="tsd-anchor"></a>getAmVersion(): string<a href="#__typegetamversion-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns string</h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/shared/State.ts#L83">shared/State.ts:83</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>getAuthenticationHeaderOverrides<a id="__typegetauthenticationheaderoverrides" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegetauthenticationheaderoverrides-1" class="tsd-anchor"></a>getAuthenticationHeaderOverrides(): Record<string, string><a href="#__typegetauthenticationheaderoverrides-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns Record<string, string></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/shared/State.ts#L64">shared/State.ts:64</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>getAuthenticationService<a id="__typegetauthenticationservice" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegetauthenticationservice-1" class="tsd-anchor"></a>getAuthenticationService(): string<a href="#__typegetauthenticationservice-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns string</h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/shared/State.ts#L66">shared/State.ts:66</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5>getAutoRefreshTimer<a id="__typegetautorefreshtimer" class="tsd-anchor"></a>:function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegetautorefreshtimer-1" class="