State: { getAdminClientId(): string; getAdminClientRedirectUri(): string; getAllowInsecureConnection(): boolean; getAmVersion(): string; getAuthenticationHeaderOverrides(): Record<string, string>; getAuthenticationService(): string; getAutoRefreshTimer(): Timeout; getAxiosRetryConfig(): IAxiosRetryConfig; getBearerToken(): string; getBearerTokenMeta(): AccessTokenMetaType; getConnectionProfilesPath(): string; getCookieName(): string; getCookieValue(): string; getCreateProgressHandler(): ( type: ProgressIndicatorType, 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(): FeatureInterface[]; 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(): JwkRsa; getServiceAccountScope(): string; getState(): StateInterface; getStopProgressHandler(): ( id: string, message: string, status?: ProgressIndicatorStatusType, ) => void; getTenant(): string; getTokenCachePath(): string; getUpdateProgressHandler(): (id: string, message: string) => void; getUseBearerTokenForAmApis(): boolean; getUsername(): string; getUserSessionTokenMeta(): UserSessionMetaType; 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: AccessTokenMetaType): void; setConnectionProfilesPath(path: string): void; setCookieName(name: string): void; setCreateProgressHandler( handler: ( type: ProgressIndicatorType, 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: FeatureInterface[]): 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: JwkRsa): void; setServiceAccountScope(scope: string): void; setStopProgressHandler( handler: ( id: string, message: string, status?: ProgressIndicatorStatusType, ) => 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: UserSessionMetaType): void; setUseTokenCache(useTokenCache: boolean): void; setVerbose(verbose: boolean): void; setVerboseHandler(handler: (message: string | object) => void): void;} Type declaration
getAdminClientId:function
getAdminClientId(): string
getAdminClientRedirectUri:function
getAdminClientRedirectUri(): string
getAllowInsecureConnection:function
getAllowInsecureConnection(): boolean
getAmVersion:function
getAuthenticationHeaderOverrides:function
getAuthenticationHeaderOverrides(): Record<string, string> Returns Record<string, string>
getAuthenticationService:function
getAuthenticationService(): string
getAutoRefreshTimer:function
getAutoRefreshTimer(): Timeout
getAxiosRetryConfig:function
getAxiosRetryConfig(): IAxiosRetryConfig Returns IAxiosRetryConfig
getBearerToken:function
getBearerTokenMeta:function
getConnectionProfilesPath:function
getConnectionProfilesPath(): string
getCookieName:function
getCookieValue:function
getCreateProgressHandler:function
getCurlirize:function
getCurlirizeHandler:function
getCurlirizeHandler(): (message: string) => void Returns (message: string) => void
getDebug:function
getDebugHandler:function
getDebugHandler(): (message: string | object) => void Returns (message: string | object) => void
getDeploymentType:function
getDeploymentType(): string
getDirectory:function
getErrorHandler:function
getErrorHandler(): (error: Error, message?: string) => void Returns (error: Error, message?: string) => void
getFeatures:function
getFrodoVersion:function
getFrodoVersion(): string
getHost:function
Returns string
the AM host base URL
getIdmHost:function
Returns string
the IDM host base URL
getLogApiKey:function
getLogApiSecret:function
getLogApiSecret(): string
getMasterKeyPath:function
getMasterKeyPath(): string
getOutputFile:function
getPassword:function
getPrintHandler:function
getPrintHandler(): ( message: string | object, type?: string, newline?: boolean,) => void Returns (message: string | object, type?: string, newline?: boolean) => void
getRealm:function
getServiceAccountId:function
getServiceAccountId(): string
getServiceAccountJwk:function
getServiceAccountJwk(): JwkRsa
getServiceAccountScope:function
getServiceAccountScope(): string
getState:function
getStopProgressHandler:function
getTenant:function
getTokenCachePath:function
getTokenCachePath(): string
getUpdateProgressHandler:function
getUpdateProgressHandler(): (id: string, message: string) => void Returns (id: string, message: string) => void
getUseBearerTokenForAmApis:function
getUseBearerTokenForAmApis(): boolean
getUsername:function
getUserSessionTokenMeta:function
getUseTokenCache:function
getUseTokenCache(): boolean
getVerbose:function
getVerboseHandler:function
getVerboseHandler(): (message: string | object) => void Returns (message: string | object) => void
reset:function
setAdminClientId:function
setAdminClientId(type: string): void
setAdminClientRedirectUri:function
setAdminClientRedirectUri(type: string): void
setAllowInsecureConnection:function
setAllowInsecureConnection(allowInsecureConnection: boolean): void Parameters
- allowInsecureConnection: boolean
Returns void
setAmVersion:function
setAmVersion(version: string): void
setAuthenticationHeaderOverrides:function
setAuthenticationHeaderOverrides(overrides: Record<string, string>): void Parameters
- overrides: Record<string, string>
Returns void
setAuthenticationService:function
setAuthenticationService(service: string): void
setAutoRefreshTimer:function
setAutoRefreshTimer(timer: Timeout): void
setAxiosRetryConfig:function
setAxiosRetryConfig(axiosRetryConfig: IAxiosRetryConfig): void Parameters
- axiosRetryConfig: IAxiosRetryConfig
Returns void
setBearerTokenMeta:function
setConnectionProfilesPath:function
setConnectionProfilesPath(path: string): void
setCookieName:function
setCookieName(name: string): void
setCreateProgressHandler:function
setCreateProgressHandler( handler: ( type: ProgressIndicatorType, total?: number, message?: string, ) => string,): void
setCurlirize:function
setCurlirize(curlirize: boolean): void
setCurlirizeHandler:function
setCurlirizeHandler(handler: (message: string) => void): void Parameters
- handler: (message: string) => void
Returns void
setDebug:function
setDebug(debug: boolean): void
setDebugHandler:function
setDebugHandler(handler: (message: string | object) => void): void Parameters
- handler: (message: string | object) => void
Returns void
setDeploymentType:function
setDeploymentType(type: string): void
setDirectory:function
setDirectory(directory: string): void
setErrorHandler:function
setErrorHandler(handler: (error: Error, message?: string) => void): void Parameters
- handler: (error: Error, message?: string) => void
Returns void
setFeatures:function
setFrodoVersion:function
setFrodoVersion(version: string): void
setHost:function
setHost(host: string): void
setIdmHost:function
setIdmHost(host: string): void
setLogApiKey:function
setLogApiKey(key: string): void
setLogApiSecret:function
setLogApiSecret(secret: string): void
setMasterKeyPath:function
setMasterKeyPath(path: string): void
setOutputFile:function
setOutputFile(file: string): void
setPassword:function
setPassword(password: string): void
setPrintHandler:function
setPrintHandler( handler: ( message: string | object, type?: string, newline?: boolean, ) => void,): void Parameters
- handler: (message: string | object, type?: string, newline?: boolean) => void
Returns void
setRealm:function
setRealm(realm: string): void
setServiceAccountId:function
setServiceAccountId(uuid: string): void
setServiceAccountJwk:function
setServiceAccountJwk(jwk: JwkRsa): void
setServiceAccountScope:function
setServiceAccountScope(scope: string): void
setStopProgressHandler:function
setTenant:function
setTenant(tenant: string): void
setTokenCachePath:function
setTokenCachePath(path: string): void
setUpdateProgressHandler:function
setUpdateProgressHandler(handler: (id: string, message: string) => void): void Parameters
- handler: (id: string, message: string) => void
Returns void
setUseBearerTokenForAmApis:function
setUseBearerTokenForAmApis(useBearerTokenForAmApis: boolean): void Parameters
- useBearerTokenForAmApis: boolean
Returns void
setUsername:function
setUsername(username: string): void
setUserSessionTokenMeta:function
setUseTokenCache:function
setUseTokenCache(useTokenCache: boolean): void
setVerbose:function
setVerbose(verbose: boolean): void
setVerboseHandler:function
setVerboseHandler(handler: (message: string | object) => void): void Parameters
- handler: (message: string | object) => void
Returns void
Get the AM host base URL