Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias State

    type State = {
        getAdminClientId(): string;
        getAdminClientRedirectUri(): string;
        getAlias(): string;
        getAllowInsecureConnection(): boolean;
        getAmsterPrivateKey(): string;
        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;
        getIsIGA(): boolean;
        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;
        getUseRealmPrefixOnManagedObjects(): boolean;
        getUsername(): string;
        getUserSessionTokenMeta(): UserSessionMetaType;
        getUseTokenCache(): boolean;
        getVerbose(): boolean;
        getVerboseHandler(): (message: string | object) => void;
        reset(): void;
        setAdminClientId(type: string): void;
        setAdminClientRedirectUri(type: string): void;
        setAlias(alias: string): void;
        setAllowInsecureConnection(allowInsecureConnection: boolean): void;
        setAmsterPrivateKey(key: string): void;
        setAmVersion(version: string): void;
        setAuthenticationHeaderOverrides(overrides: Record<string, string>): void;
        setAuthenticationService(service: string): void;
        setAutoRefreshTimer(timer: Timeout): void;
        setAxiosRetryConfig(axiosRetryConfig: IAxiosRetryConfig): void;
        setAxiosRetryStrategy(strategy: RetryStrategy): 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;
        setIsIGA(isIGA: boolean): 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;
        setUseRealmPrefixOnManagedObjects(
            useRealmPrefixOnManagedObjects: 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;
    }
    Index

    Methods

    getAdminClientId getAdminClientRedirectUri getAlias getAllowInsecureConnection getAmsterPrivateKey getAmVersion getAuthenticationHeaderOverrides getAuthenticationService getAutoRefreshTimer getAxiosRetryConfig getBearerToken getBearerTokenMeta getConnectionProfilesPath getCookieName getCookieValue getCreateProgressHandler getCurlirize getCurlirizeHandler getDebug getDebugHandler getDeploymentType getDirectory getErrorHandler getFeatures getFrodoVersion getHost getIdmHost getIsIGA getLogApiKey getLogApiSecret getMasterKeyPath getOutputFile getPassword getPrintHandler getRealm getServiceAccountId getServiceAccountJwk getServiceAccountScope getState getStopProgressHandler getTenant getTokenCachePath getUpdateProgressHandler getUseBearerTokenForAmApis getUseRealmPrefixOnManagedObjects getUsername getUserSessionTokenMeta getUseTokenCache getVerbose getVerboseHandler reset setAdminClientId setAdminClientRedirectUri setAlias setAllowInsecureConnection setAmsterPrivateKey setAmVersion setAuthenticationHeaderOverrides setAuthenticationService setAutoRefreshTimer setAxiosRetryConfig setAxiosRetryStrategy setBearerTokenMeta setConnectionProfilesPath setCookieName setCreateProgressHandler setCurlirize setCurlirizeHandler setDebug setDebugHandler setDeploymentType setDirectory setErrorHandler setFeatures setFrodoVersion setHost setIdmHost setIsIGA setLogApiKey setLogApiSecret setMasterKeyPath setOutputFile setPassword setPrintHandler setRealm setServiceAccountId setServiceAccountJwk setServiceAccountScope setStopProgressHandler setTenant setTokenCachePath setUpdateProgressHandler setUseBearerTokenForAmApis setUseRealmPrefixOnManagedObjects setUsername setUserSessionTokenMeta setUseTokenCache setVerbose setVerboseHandler

    Methods

    • Returns Record<string, string>

    • Returns IAxiosRetryConfig

    • Returns (message: string) => void

    • Returns (message: string | object) => void

    • Returns (error: Error, message?: string) => void

    • Get the AM host base URL

      Returns string

      the AM host base URL

    • Get the IDM host base URL

      Returns string

      the IDM host base URL

    • Returns (message: string | object, type?: string, newline?: boolean) => void

    • Returns string

      since v0.17.0 use getHost instead

    • Returns (id: string, message: string) => void

    • Returns (message: string | object) => void

    • Parameters

      • type: string

      Returns void

    • Parameters

      • type: string

      Returns void

    • Parameters

      • alias: string

      Returns void

    • Parameters

      • allowInsecureConnection: boolean

      Returns void

    • Parameters

      • key: string

      Returns void

    • Parameters

      • version: string

      Returns void

    • Parameters

      • overrides: Record<string, string>

      Returns void

    • Parameters

      • service: string

      Returns void

    • Parameters

      • timer: Timeout

      Returns void

    • Parameters

      • axiosRetryConfig: IAxiosRetryConfig

      Returns void

    • Parameters

      • path: string

      Returns void

    • Parameters

      • name: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      • curlirize: boolean

      Returns void

    • Parameters

      • handler: (message: string) => void

      Returns void

    • Parameters

      • debug: boolean

      Returns void

    • Parameters

      • handler: (message: string | object) => void

      Returns void

    • Parameters

      • type: string

      Returns void

    • Parameters

      • directory: string

      Returns void

    • Parameters

      • handler: (error: Error, message?: string) => void

      Returns void

    • Parameters

      • version: string

      Returns void

    • Set the AM host base URL

      Parameters

      Returns void

    • Parameters

      • isIGA: boolean

      Returns void

    • Parameters

      • key: string

      Returns void

    • Parameters

      • secret: string

      Returns void

    • Parameters

      • path: string

      Returns void

    • Parameters

      • file: string

      Returns void

    • Parameters

      • password: string

      Returns void

    • Parameters

      • handler: (message: string | object, type?: string, newline?: boolean) => void

      Returns void

    • Parameters

      • realm: string

      Returns void

    • Parameters

      • uuid: string

      Returns void

    • Parameters

      • scope: string

      Returns void

    • Parameters

      • tenant: string

      Returns void

      since v0.17.0 use setHost(host: string) instead

    • Parameters

      • path: string

      Returns void

    • Parameters

      • handler: (id: string, message: string) => void

      Returns void

    • Parameters

      • useBearerTokenForAmApis: boolean

      Returns void

    • Parameters

      • useRealmPrefixOnManagedObjects: boolean

      Returns void

    • Parameters

      • username: string

      Returns void

    • Parameters

      • useTokenCache: boolean

      Returns void

    • Parameters

      • verbose: boolean

      Returns void

    • Parameters

      • handler: (message: string | object) => void

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    getAdminClientIdgetAdminClientRedirectUrigetAliasgetAllowInsecureConnectiongetAmsterPrivateKeygetAmVersiongetAuthenticationHeaderOverridesgetAuthenticationServicegetAutoRefreshTimergetAxiosRetryConfiggetBearerTokengetBearerTokenMetagetConnectionProfilesPathgetCookieNamegetCookieValuegetCreateProgressHandlergetCurlirizegetCurlirizeHandlergetDebuggetDebugHandlergetDeploymentTypegetDirectorygetErrorHandlergetFeaturesgetFrodoVersiongetHostgetIdmHostgetIsIGAgetLogApiKeygetLogApiSecretgetMasterKeyPathgetOutputFilegetPasswordgetPrintHandlergetRealmgetServiceAccountIdgetServiceAccountJwkgetServiceAccountScopegetStategetStopProgressHandlergetTenantgetTokenCachePathgetUpdateProgressHandlergetUseBearerTokenForAmApisgetUseRealmPrefixOnManagedObjectsgetUsernamegetUserSessionTokenMetagetUseTokenCachegetVerbosegetVerboseHandlerresetsetAdminClientIdsetAdminClientRedirectUrisetAliassetAllowInsecureConnectionsetAmsterPrivateKeysetAmVersionsetAuthenticationHeaderOverridessetAuthenticationServicesetAutoRefreshTimersetAxiosRetryConfigsetAxiosRetryStrategysetBearerTokenMetasetConnectionProfilesPathsetCookieNamesetCreateProgressHandlersetCurlirizesetCurlirizeHandlersetDebugsetDebugHandlersetDeploymentTypesetDirectorysetErrorHandlersetFeaturessetFrodoVersionsetHostsetIdmHostsetIsIGAsetLogApiKeysetLogApiSecretsetMasterKeyPathsetOutputFilesetPasswordsetPrintHandlersetRealmsetServiceAccountIdsetServiceAccountJwksetServiceAccountScopesetStopProgressHandlersetTenantsetTokenCachePathsetUpdateProgressHandlersetUseBearerTokenForAmApissetUseRealmPrefixOnManagedObjectssetUsernamesetUserSessionTokenMetasetUseTokenCachesetVerbosesetVerboseHandler