ConfigParams | express-openid-connect (original) (raw)

Properties

Optional afterCallback

afterCallback?: ((req, res, session, decodedState) => Session | Promise<Session>)

Type declaration

• • (req, res, session, decodedState): Session | Promise<Session>

  • Parameters

    * ##### req: [OpenidRequest](OpenidRequest.html)  
    * ##### res: [OpenidResponse](OpenidResponse.html)  
    * ##### session: [Session](Session.html)  
    * ##### decodedState: {  
    \[key: string\]: any;  
    }  
             * ##### \[key: string\]: any

  Returns Session | Promise<Session>

Optional attemptSilentLogin

attemptSilentLogin?: boolean

Optional auth0Logout

auth0Logout?: boolean

Optional authRequired

authRequired?: boolean

Optional authorizationParams

authorizationParams?: AuthorizationParameters

Optional backchannelLogout

Optional baseURL

baseURL?: string

Optional clientAssertionSigningAlg

clientAssertionSigningAlg?: "RS256" | "RS384" | "RS512" | "PS256" | "PS384" | "PS512" | "ES256" | "ES256K" | "ES384" | "ES512" | "EdDSA"

Optional clientAssertionSigningKey

clientAssertionSigningKey?: KeyObject | KeyInput | JSONWebKey

Optional clientAuthMethod

clientAuthMethod?: string

Optional clientID

clientID?: string

Optional clientSecret

clientSecret?: string

Optional clockTolerance

clockTolerance?: number

Optional discoveryCacheMaxAge

discoveryCacheMaxAge?: number

Optional enableTelemetry

enableTelemetry?: boolean

Optional errorOnRequiredAuth

errorOnRequiredAuth?: boolean

Optional getLoginState

getLoginState?: ((req, options) => object)

Type declaration

• • (req, options): object

  • Returns object

Optional httpAgent

httpAgent?: {
http?: false | Agent;
http2?: unknown;
https?: false | Agent;
}

Type declaration

• Optional http?: false | Agent

• Optional http2?: unknown

• Optional https?: false | Agent

Optional httpTimeout

httpTimeout?: number

Optional httpUserAgent

httpUserAgent?: string

Optional idTokenSigningAlg

idTokenSigningAlg?: string

Optional identityClaimFilter

identityClaimFilter?: string[]

Optional idpLogout

idpLogout?: boolean

Optional issuerBaseURL

issuerBaseURL?: string

Optional legacySameSiteCookie

legacySameSiteCookie?: boolean

Optional logoutParams

logoutParams?: {
[key: string]: any;
}

Type declaration

• [key: string]: any

Optional pushedAuthorizationRequests

pushedAuthorizationRequests?: boolean

Optional routes

routes?: {
backchannelLogout?: string;
callback?: string | false;
login?: string | false;
logout?: string | false;
postLogoutRedirect?: string;
}

Type declaration

• Optional backchannelLogout?: string

• Optional callback?: string | false

• Optional login?: string | false

• Optional logout?: string | false

• Optional postLogoutRedirect?: string

Optional secret

secret?: string | string[]

Optional session

Optional tokenEndpointParams

Optional transactionCookie

transactionCookie?: Pick<CookieConfigParams, "sameSite"> & {
name?: string;
}

Type declaration

• Optional name?: string