Interface AuthState

Resolved authentication state used throughout the client lifecycle. Created once by resolveCredentialChain and passed to resolveAuthHeaders on every request.

interface AuthState {
    accessToken?: string;
    accessTokenProvider?: () => string | Promise<string>;
    accountId?: string;
    apiKey?: string;
    apiKeyHeader: string;
    autoRefresh: boolean;
    configDir?: string;
    fetcher?: FetchLike;
    mode: "apiKey" | "bearerStatic" | "bearerProvider" | "sso";
    ssoProfile?: SsoProfile;
}

Properties

accessToken? accessTokenProvider? accountId? apiKey? apiKeyHeader autoRefresh configDir? fetcher? mode ssoProfile?

Properties

OptionalaccessToken

accessToken?: string

OptionalaccessTokenProvider

accessTokenProvider?: () => string | Promise<string>

OptionalaccountId

accountId?: string

OptionalapiKey

apiKey?: string

apiKeyHeader

apiKeyHeader: string

autoRefresh

autoRefresh: boolean

OptionalconfigDir

configDir?: string

Optionalfetcher

fetcher?: FetchLike

mode

mode: "apiKey" | "bearerStatic" | "bearerProvider" | "sso"

OptionalssoProfile

ssoProfile?: SsoProfile

Settings

Member Visibility

On This Page

Properties