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

Interface ConfigParams

interface ConfigParams {
afterCallback?: (
req: OpenidRequest,
res: OpenidResponse,
session: Session,
decodedState: { [key: string]: any },
) => Session | Promise<Session>;
attemptSilentLogin?: boolean;
auth0Logout?: boolean;
authorizationParams?: AuthorizationParameters;
authRequired?: boolean;
backchannelLogout?: boolean | BackchannelLogoutOptions;
baseURL?: string;
clientAssertionSigningAlg?:
| "RS256"
| "RS384"
| "RS512"
| "PS256"
| "PS384"
| "PS512"
| "ES256"
| "ES256K"
| "ES384"
| "ES512"
| "EdDSA";
clientAssertionSigningKey?: KeyObject
| KeyInput
| JSONWebKey;
clientAuthMethod?: string;
clientID?: string;
clientSecret?: string;
clockTolerance?: number;
discoveryCacheMaxAge?: number;
enableTelemetry?: boolean;
errorOnRequiredAuth?: boolean;
getLoginState?: (req: OpenidRequest, options: LoginOptions) => object;
httpAgent?: {
http?: false | Agent;
http2?: unknown;
https?: false | Agent;
};
httpTimeout?: number;
httpUserAgent?: string;
identityClaimFilter?: string[];
idpLogout?: boolean;
idTokenSigningAlg?: string;
issuerBaseURL?: string;
legacySameSiteCookie?: boolean;
logoutParams?: { [key: string]: any };
pushedAuthorizationRequests?: boolean;
routes?: {
backchannelLogout?: string;
callback?: string | false;
login?: string | false;
logout?: string | false;
postLogoutRedirect?: string;
};
secret?: string
| string[];
session?: SessionConfigParams;
tokenEndpointParams?: TokenParameters;
transactionCookie?: Pick<CookieConfigParams, "sameSite"> & {
name?: string;
};
}

Index

Properties

OptionalafterCallback

OptionalattemptSilentLogin

attemptSilentLogin?: boolean

Optionalauth0Logout

auth0Logout?: boolean

authorizationParams?: AuthorizationParameters

OptionalauthRequired

authRequired?: boolean

OptionalbackchannelLogout

OptionalbaseURL

baseURL?: string

OptionalclientAssertionSigningAlg

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

OptionalclientAssertionSigningKey

clientAssertionSigningKey?: KeyObject | KeyInput | JSONWebKey

OptionalclientAuthMethod

clientAuthMethod?: string

OptionalclientID

clientID?: string

OptionalclientSecret

clientSecret?: string

OptionalclockTolerance

clockTolerance?: number

OptionaldiscoveryCacheMaxAge

discoveryCacheMaxAge?: number

OptionalenableTelemetry

enableTelemetry?: boolean

OptionalerrorOnRequiredAuth

errorOnRequiredAuth?: boolean

OptionalgetLoginState

OptionalhttpAgent

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

OptionalhttpTimeout

httpTimeout?: number

OptionalhttpUserAgent

httpUserAgent?: string

OptionalidentityClaimFilter

identityClaimFilter?: string[]

OptionalidpLogout

idpLogout?: boolean

OptionalidTokenSigningAlg

idTokenSigningAlg?: string

OptionalissuerBaseURL

issuerBaseURL?: string

OptionallegacySameSiteCookie

legacySameSiteCookie?: boolean

OptionallogoutParams

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

OptionalpushedAuthorizationRequests

pushedAuthorizationRequests?: boolean

Optionalroutes

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

Type declaration

Optionalsecret

secret?: string | string[]

Optionalsession

OptionaltokenEndpointParams

OptionaltransactionCookie

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