Frodo Library - v4.8.5
    Preparing search index...

    Type Alias State

    type State = {
        getActiveCredentialSource(): "user" | "svcacct" | "amster" | "browser";
        getAdminClientId(): string;
        getAdminClientRedirectUri(): string;
        getAlias(): string;
        getAllowInsecureConnection(): boolean;
        getAmBearerTokenAcceptanceProbed(): boolean;
        getAmCredentialProvider(): AmCredentialProvider;
        getAmsterPrivateKey(): string;
        getAmVersion(): string;
        getAuthenticationHeaderOverrides(): Record<string, string>;
        getAuthenticationService(): string;
        getAuthMode(): "noninteractive" | "interactive";
        getAutoRefreshTimer(): Timeout;
        getAxiosRetryConfig(): IAxiosRetryConfig;
        getBearerToken(): string;
        getBearerTokenMeta(): AccessTokenMetaType;
        getBrowserLoginClientId(): string;
        getBrowserLoginScope(): string;
        getCallerTrustTier(): "full-trust" | "delegated";
        getCallerTrustTierResolver(): CallerTrustTierResolver;
        getColorTheme(): "dark" | "light";
        getConfigurationHeaderOverrides(): Record<string, string>;
        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;
        getDefaultCredential(): "user" | "svcacct" | "amster";
        getDeploymentType(): string;
        getDirectory(): string;
        getEnv(key: string): string;
        getEnvs(): Record<string, string>;
        getErrorHandler(): (error: Error, message?: string) => void;
        getFeatures(): FeatureInterface[];
        getFrodoVersion(): string;
        getHost(): string;
        getIdmHost(): string;
        getIdmVersion(): string;
        getIdToken(): string;
        getIsIGA(): boolean;
        getIsPingFed(): boolean;
        getLogApiKey(): string;
        getLogApiSecret(): string;
        getMasterKeyPath(): string;
        getNeedsReauthentication(): boolean;
        getOutputFile(): string;
        getPassword(): string;
        getPfBearerToken(): string;
        getPfBearerTokenMeta(): AccessTokenMetaType;
        getPrintHandler(): (
            message: string | object,
            type?: string,
            newline?: boolean,
        ) => void;
        getPrivilegeEscalationHandler(): () => Promise<boolean>;
        getRealm(): string;
        getRefreshToken(): string;
        getServiceAccountId(): string;
        getServiceAccountJwk(): JwkRsa;
        getServiceAccountScope(): string;
        getState(): StateInterface;
        getStopProgressHandler(): (
            id: string,
            message: string,
            status?: ProgressIndicatorStatusType,
        ) => void;
        getTenant(): string;
        getTokenCachePath(): string;
        getTokenRefreshHandler(): TokenRefreshHandler;
        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;
        setActiveCredentialSource(
            source: "user" | "svcacct" | "amster" | "browser",
        ): void;
        setAdminClientId(type: string): void;
        setAdminClientRedirectUri(type: string): void;
        setAlias(alias: string): void;
        setAllowInsecureConnection(allowInsecureConnection: boolean): void;
        setAmBearerTokenAcceptanceProbed(probed: boolean): void;
        setAmCredentialProvider(provider: AmCredentialProvider): void;
        setAmsterPrivateKey(key: string): void;
        setAmVersion(version: string): void;
        setAuthenticationHeaderOverrides(overrides: Record<string, string>): void;
        setAuthenticationService(service: string): void;
        setAuthMode(authMode: "noninteractive" | "interactive"): void;
        setAutoRefreshTimer(timer: Timeout): void;
        setAxiosRetryConfig(axiosRetryConfig: IAxiosRetryConfig): void;
        setAxiosRetryStrategy(strategy: RetryStrategy): void;
        setBearerTokenMeta(token: AccessTokenMetaType): void;
        setBrowserLoginClientId(clientId: string): void;
        setBrowserLoginScope(scope: string): void;
        setCallerTrustTier(tier: "full-trust" | "delegated"): void;
        setCallerTrustTierResolver(resolver: CallerTrustTierResolver): void;
        setColorTheme(theme: "dark" | "light"): void;
        setConfigurationHeaderOverrides(overrides: Record<string, string>): 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;
        setDefaultCredential(
            defaultCredential: "user" | "svcacct" | "amster",
        ): void;
        setDeploymentType(type: string): void;
        setDirectory(directory: string): void;
        setEnv(key: string, value: string): void;
        setEnvs(env: Record<string, string>, clear?: boolean): 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;
        setIdmVersion(version: string): void;
        setIdToken(token: string): void;
        setIsIGA(isIGA: boolean): void;
        setIsPingFed(isPingFed: boolean): void;
        setLogApiKey(key: string): void;
        setLogApiSecret(secret: string): void;
        setMasterKeyPath(path: string): void;
        setNeedsReauthentication(needsReauthentication: boolean): void;
        setOutputFile(file: string): void;
        setPassword(password: string): void;
        setPfBearerTokenMeta(token: AccessTokenMetaType): void;
        setPrintHandler(
            handler: (
                message: string | object,
                type?: string,
                newline?: boolean,
            ) => void,
        ): void;
        setPrivilegeEscalationHandler(handler: () => Promise<boolean>): void;
        setRealm(realm: string): void;
        setRefreshToken(token: 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;
        setTokenRefreshHandler(handler: TokenRefreshHandler): 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

    getActiveCredentialSource getAdminClientId getAdminClientRedirectUri getAlias getAllowInsecureConnection getAmBearerTokenAcceptanceProbed getAmCredentialProvider getAmsterPrivateKey getAmVersion getAuthenticationHeaderOverrides getAuthenticationService getAuthMode getAutoRefreshTimer getAxiosRetryConfig getBearerToken getBearerTokenMeta getBrowserLoginClientId getBrowserLoginScope getCallerTrustTier getCallerTrustTierResolver getColorTheme getConfigurationHeaderOverrides getConnectionProfilesPath getCookieName getCookieValue getCreateProgressHandler getCurlirize getCurlirizeHandler getDebug getDebugHandler getDefaultCredential getDeploymentType getDirectory getEnv getEnvs getErrorHandler getFeatures getFrodoVersion getHost getIdmHost getIdmVersion getIdToken getIsIGA getIsPingFed getLogApiKey getLogApiSecret getMasterKeyPath getNeedsReauthentication getOutputFile getPassword getPfBearerToken getPfBearerTokenMeta getPrintHandler getPrivilegeEscalationHandler getRealm getRefreshToken getServiceAccountId getServiceAccountJwk getServiceAccountScope getState getStopProgressHandler getTenant getTokenCachePath getTokenRefreshHandler getUpdateProgressHandler getUseBearerTokenForAmApis getUseRealmPrefixOnManagedObjects getUsername getUserSessionTokenMeta getUseTokenCache getVerbose getVerboseHandler reset setActiveCredentialSource setAdminClientId setAdminClientRedirectUri setAlias setAllowInsecureConnection setAmBearerTokenAcceptanceProbed setAmCredentialProvider setAmsterPrivateKey setAmVersion setAuthenticationHeaderOverrides setAuthenticationService setAuthMode setAutoRefreshTimer setAxiosRetryConfig setAxiosRetryStrategy setBearerTokenMeta setBrowserLoginClientId setBrowserLoginScope setCallerTrustTier setCallerTrustTierResolver setColorTheme setConfigurationHeaderOverrides setConnectionProfilesPath setCookieName setCreateProgressHandler setCurlirize setCurlirizeHandler setDebug setDebugHandler setDefaultCredential setDeploymentType setDirectory setEnv setEnvs setErrorHandler setFeatures setFrodoVersion setHost setIdmHost setIdmVersion setIdToken setIsIGA setIsPingFed setLogApiKey setLogApiSecret setMasterKeyPath setNeedsReauthentication setOutputFile setPassword setPfBearerTokenMeta setPrintHandler setPrivilegeEscalationHandler setRealm setRefreshToken setServiceAccountId setServiceAccountJwk setServiceAccountScope setStopProgressHandler setTenant setTokenCachePath setTokenRefreshHandler setUpdateProgressHandler setUseBearerTokenForAmApis setUseRealmPrefixOnManagedObjects setUsername setUserSessionTokenMeta setUseTokenCache setVerbose setVerboseHandler

    Methods

    • Returns "user" | "svcacct" | "amster" | "browser"

    • Returns Record<string, string>

    • Returns "noninteractive" | "interactive"

    • Returns IAxiosRetryConfig

    • Returns "full-trust" | "delegated"

    • Returns Record<string, string>

    • Returns (message: string) => void

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

    • Returns "user" | "svcacct" | "amster"

    • 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 () => Promise<boolean>

    • Returns string

      since v0.17.0 use getHost instead

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

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

    • Which credential type is currently active for this session — set once, wherever getTokens()'s non-interactive branches (or a browser login) actually activate a credential. Used by ops/PrivilegeEscalationOps.ts to know where on the escalation ladder the current session sits.

      Parameters

      • source: "user" | "svcacct" | "amster" | "browser"

      Returns void

    • Parameters

      • type: string

      Returns void

    • Parameters

      • type: string

      Returns void

    • Parameters

      • alias: string

      Returns void

    • Parameters

      • allowInsecureConnection: boolean

      Returns void

    • Parameters

      • probed: 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

      • authMode: "noninteractive" | "interactive"

      Returns void

    • Parameters

      • timer: Timeout

      Returns void

    • Parameters

      • axiosRetryConfig: IAxiosRetryConfig

      Returns void

    • Parameters

      • clientId: string

      Returns void

    • Parameters

      • scope: string

      Returns void

    • Cached for the life of the session by determineCallerTrustTier() (ops/CallerTrustTierOps.ts).

      Parameters

      • tier: "full-trust" | "delegated"

      Returns void

    • Parameters

      • theme: "dark" | "light"

      Returns void

    • Parameters

      • overrides: Record<string, string>

      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

    • Explicit, persisted preference for which non-interactive credential type a profile with more than one configured should use — an undefined value means "no preference set," not "none of the above." Unlike authMode, never mirrors ambient session state on save; only ever written when the caller explicitly requests it (e.g. via --default-credential), so an unrelated save never silently overwrites a previously-configured preference. See AuthenticateOps.ts's tryBrowserLogin()/getTokens() for how this is consulted.

      Parameters

      • defaultCredential: "user" | "svcacct" | "amster"

      Returns void

    • Parameters

      • type: string

      Returns void

    • Parameters

      • directory: string

      Returns void

    • Parameters

      • key: string
      • value: string

      Returns void

    • Parameters

      • env: Record<string, string>
      • Optionalclear: boolean

      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

      • version: string

      Returns void

    • Parameters

      • token: string

      Returns void

    • Parameters

      • isIGA: boolean

      Returns void

    • Parameters

      • isPingFed: boolean

      Returns void

    • Parameters

      • secret: string

      Returns void

    • Parameters

      • path: string

      Returns void

    • Parameters

      • needsReauthentication: boolean

      Returns void

    • Parameters

      • file: string

      Returns void

    • Parameters

      • password: string

      Returns void

    • Parameters

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

      Returns void

    • Extension point letting api/BaseApi.ts trigger a credential-privilege escalation without importing ops/AuthenticateOps.ts directly (would be circular — AuthenticateOps.ts already depends on BaseApi.ts transitively). Installed once by getTokens() after the initial credential activates; called by attachCredentialInterceptor() when a pre-flight scope check fails. Resolves true if a higher-tier credential was found and activated (the failed request should be retried), false if there is nothing left to escalate to.

      Parameters

      • handler: () => Promise<boolean>

      Returns void

    • Parameters

      • realm: string

      Returns void

    • Parameters

      • token: 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
    getActiveCredentialSourcegetAdminClientIdgetAdminClientRedirectUrigetAliasgetAllowInsecureConnectiongetAmBearerTokenAcceptanceProbedgetAmCredentialProvidergetAmsterPrivateKeygetAmVersiongetAuthenticationHeaderOverridesgetAuthenticationServicegetAuthModegetAutoRefreshTimergetAxiosRetryConfiggetBearerTokengetBearerTokenMetagetBrowserLoginClientIdgetBrowserLoginScopegetCallerTrustTiergetCallerTrustTierResolvergetColorThemegetConfigurationHeaderOverridesgetConnectionProfilesPathgetCookieNamegetCookieValuegetCreateProgressHandlergetCurlirizegetCurlirizeHandlergetDebuggetDebugHandlergetDefaultCredentialgetDeploymentTypegetDirectorygetEnvgetEnvsgetErrorHandlergetFeaturesgetFrodoVersiongetHostgetIdmHostgetIdmVersiongetIdTokengetIsIGAgetIsPingFedgetLogApiKeygetLogApiSecretgetMasterKeyPathgetNeedsReauthenticationgetOutputFilegetPasswordgetPfBearerTokengetPfBearerTokenMetagetPrintHandlergetPrivilegeEscalationHandlergetRealmgetRefreshTokengetServiceAccountIdgetServiceAccountJwkgetServiceAccountScopegetStategetStopProgressHandlergetTenantgetTokenCachePathgetTokenRefreshHandlergetUpdateProgressHandlergetUseBearerTokenForAmApisgetUseRealmPrefixOnManagedObjectsgetUsernamegetUserSessionTokenMetagetUseTokenCachegetVerbosegetVerboseHandlerresetsetActiveCredentialSourcesetAdminClientIdsetAdminClientRedirectUrisetAliassetAllowInsecureConnectionsetAmBearerTokenAcceptanceProbedsetAmCredentialProvidersetAmsterPrivateKeysetAmVersionsetAuthenticationHeaderOverridessetAuthenticationServicesetAuthModesetAutoRefreshTimersetAxiosRetryConfigsetAxiosRetryStrategysetBearerTokenMetasetBrowserLoginClientIdsetBrowserLoginScopesetCallerTrustTiersetCallerTrustTierResolversetColorThemesetConfigurationHeaderOverridessetConnectionProfilesPathsetCookieNamesetCreateProgressHandlersetCurlirizesetCurlirizeHandlersetDebugsetDebugHandlersetDefaultCredentialsetDeploymentTypesetDirectorysetEnvsetEnvssetErrorHandlersetFeaturessetFrodoVersionsetHostsetIdmHostsetIdmVersionsetIdTokensetIsIGAsetIsPingFedsetLogApiKeysetLogApiSecretsetMasterKeyPathsetNeedsReauthenticationsetOutputFilesetPasswordsetPfBearerTokenMetasetPrintHandlersetPrivilegeEscalationHandlersetRealmsetRefreshTokensetServiceAccountIdsetServiceAccountJwksetServiceAccountScopesetStopProgressHandlersetTenantsetTokenCachePathsetTokenRefreshHandlersetUpdateProgressHandlersetUseBearerTokenForAmApissetUseRealmPrefixOnManagedObjectssetUsernamesetUserSessionTokenMetasetUseTokenCachesetVerbosesetVerboseHandler