Interface AuthClientOptions

interface AuthClientOptions {
    allowInsecureRequests?: boolean;
    appBaseUrl: string;
    authorizationParameters?: AuthorizationParameters;
    beforeSessionSaved?: BeforeSessionSavedHook;
    clientAssertionSigningAlg?: string;
    clientAssertionSigningKey?: string | CryptoKey;
    clientId: string;
    clientSecret?: string;
    domain: string;
    enableTelemetry?: boolean;
    fetch?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    };
    httpTimeout?: number;
    jwksCache?: JWKSCacheInput;
    onCallback?: OnCallbackHook;
    pushedAuthorizationRequests?: boolean;
    routes?: Partial<
        Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
    >;
    secret: string;
    sessionStore: AbstractSessionStore;
    signInReturnToPath?: string;
    transactionStore: TransactionStore;
}

Properties

allowInsecureRequests? appBaseUrl authorizationParameters? beforeSessionSaved? clientAssertionSigningAlg? clientAssertionSigningKey? clientId clientSecret? domain enableTelemetry? fetch? httpTimeout? jwksCache? onCallback? pushedAuthorizationRequests? routes? secret sessionStore signInReturnToPath? transactionStore

Properties

OptionalallowInsecureRequests

allowInsecureRequests?: boolean

appBaseUrl

appBaseUrl: string

OptionalauthorizationParameters

authorizationParameters?: AuthorizationParameters

OptionalbeforeSessionSaved

beforeSessionSaved?: BeforeSessionSavedHook

OptionalclientAssertionSigningAlg

clientAssertionSigningAlg?: string

OptionalclientAssertionSigningKey

clientAssertionSigningKey?: string | CryptoKey

clientId

clientId: string

OptionalclientSecret

clientSecret?: string

domain

domain: string

OptionalenableTelemetry

enableTelemetry?: boolean

Optionalfetch

fetch?: {
    (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
    (input: string | URL | Request, init?: RequestInit): Promise<Response>;
}

Type declaration

    • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • (input: string | URL | Request, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: string | URL | Request
      • Optionalinit: RequestInit

      Returns Promise<Response>

OptionalhttpTimeout

httpTimeout?: number

OptionaljwksCache

jwksCache?: JWKSCacheInput

OptionalonCallback

onCallback?: OnCallbackHook

OptionalpushedAuthorizationRequests

pushedAuthorizationRequests?: boolean

Optionalroutes

routes?: Partial<
    Pick<Routes, "login" | "callback" | "logout" | "backChannelLogout">,
>

secret

secret: string

sessionStore

sessionStore: AbstractSessionStore

OptionalsignInReturnToPath

signInReturnToPath?: string

transactionStore

transactionStore: TransactionStore

Settings

Member Visibility

On This Page

Properties