Skip to content
oidc-provider

Configuration

Defined in: @types/oidc-provider/index.d.ts:935

Properties

Section titled “Properties”

acceptQueryParamAccessTokens?

Section titled “acceptQueryParamAccessTokens?”

optional acceptQueryParamAccessTokens?: boolean

Defined in: @types/oidc-provider/index.d.ts:1413

acrValues?

Section titled “acrValues?”

optional acrValues?: string[] | Set<string>

Defined in: @types/oidc-provider/index.d.ts:936

adapter?

Section titled “adapter?”

optional adapter?: AdapterFactory | AdapterConstructor

Defined in: @types/oidc-provider/index.d.ts:938

allowOmittingSingleRegisteredRedirectUri?

Section titled “allowOmittingSingleRegisteredRedirectUri?”

optional allowOmittingSingleRegisteredRedirectUri?: boolean

Defined in: @types/oidc-provider/index.d.ts:1411

assertJwtClientAuthClaimsAndHeader?

Section titled “assertJwtClientAuthClaimsAndHeader?”

optional assertJwtClientAuthClaimsAndHeader?: (ctx, claims, header, client) => CanBePromise<void>

Defined in: @types/oidc-provider/index.d.ts:999

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

claims
Section titled “claims”

Record<string, JsonValue>

Section titled “header”

Record<string, JsonValue>

client
Section titled “client”

Client

Returns

Section titled “Returns”

CanBePromise<void>

claims?

Section titled “claims?”

optional claims?: object

Defined in: @types/oidc-provider/index.d.ts:940

Index Signature

Section titled “Index Signature”

[key: string]: string[] | null

clientAuthMethods?

Section titled “clientAuthMethods?”

optional clientAuthMethods?: ClientAuthMethod[]

Defined in: @types/oidc-provider/index.d.ts:1364

clientBasedCORS?

Section titled “clientBasedCORS?”

optional clientBasedCORS?: (ctx, origin, client) => boolean

Defined in: @types/oidc-provider/index.d.ts:946

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

origin
Section titled “origin”

string

client
Section titled “client”

Client

Returns

Section titled “Returns”

boolean

clientDefaults?

Section titled “clientDefaults?”

optional clientDefaults?: AllClientMetadata

Defined in: @types/oidc-provider/index.d.ts:967

clients?

Section titled “clients?”

optional clients?: ClientMetadata[]

Defined in: @types/oidc-provider/index.d.ts:948

clockTolerance?

Section titled “clockTolerance?”

optional clockTolerance?: number

Defined in: @types/oidc-provider/index.d.ts:969

conformIdTokenClaims?

Section titled “conformIdTokenClaims?”

optional conformIdTokenClaims?: boolean

Defined in: @types/oidc-provider/index.d.ts:971

cookies?

Section titled “cookies?”

optional cookies?: object

Defined in: @types/oidc-provider/index.d.ts:973

keys?

Section titled “keys?”

optional keys?: (string | Buffer<ArrayBufferLike>)[] | Keygrip

long?

Section titled “long?”

optional long?: CookiesSetOptions

names?

Section titled “names?”

optional names?: object

names.interaction?
Section titled “names.interaction?”

optional interaction?: string

names.resume?
Section titled “names.resume?”

optional resume?: string

names.session?
Section titled “names.session?”

optional session?: string

names.state?
Section titled “names.state?”

optional state?: string

short?

Section titled “short?”

optional short?: CookiesSetOptions

discovery?

Section titled “discovery?”

optional discovery?: UnknownObject

Defined in: @types/oidc-provider/index.d.ts:989

enabledJWA?

Section titled “enabledJWA?”

optional enabledJWA?: object

Defined in: @types/oidc-provider/index.d.ts:1424

authorizationEncryptionAlgValues?

Section titled “authorizationEncryptionAlgValues?”

optional authorizationEncryptionAlgValues?: EncryptionAlgValues[]

authorizationEncryptionEncValues?

Section titled “authorizationEncryptionEncValues?”

optional authorizationEncryptionEncValues?: EncryptionEncValues[]

authorizationSigningAlgValues?

Section titled “authorizationSigningAlgValues?”

optional authorizationSigningAlgValues?: SigningAlgorithm[]

clientAuthSigningAlgValues?

Section titled “clientAuthSigningAlgValues?”

optional clientAuthSigningAlgValues?: SigningAlgorithm[]

dPoPSigningAlgValues?

Section titled “dPoPSigningAlgValues?”

optional dPoPSigningAlgValues?: AsymmetricSigningAlgorithm[]

idTokenEncryptionAlgValues?

Section titled “idTokenEncryptionAlgValues?”

optional idTokenEncryptionAlgValues?: EncryptionAlgValues[]

idTokenEncryptionEncValues?

Section titled “idTokenEncryptionEncValues?”

optional idTokenEncryptionEncValues?: EncryptionEncValues[]

idTokenSigningAlgValues?

Section titled “idTokenSigningAlgValues?”

optional idTokenSigningAlgValues?: SigningAlgorithmWithNone[]

introspectionEncryptionAlgValues?

Section titled “introspectionEncryptionAlgValues?”

optional introspectionEncryptionAlgValues?: EncryptionAlgValues[]

introspectionEncryptionEncValues?

Section titled “introspectionEncryptionEncValues?”

optional introspectionEncryptionEncValues?: EncryptionEncValues[]

introspectionSigningAlgValues?

Section titled “introspectionSigningAlgValues?”

optional introspectionSigningAlgValues?: SigningAlgorithmWithNone[]

requestObjectEncryptionAlgValues?

Section titled “requestObjectEncryptionAlgValues?”

optional requestObjectEncryptionAlgValues?: EncryptionAlgValues[]

requestObjectEncryptionEncValues?

Section titled “requestObjectEncryptionEncValues?”

optional requestObjectEncryptionEncValues?: EncryptionEncValues[]

requestObjectSigningAlgValues?

Section titled “requestObjectSigningAlgValues?”

optional requestObjectSigningAlgValues?: SigningAlgorithmWithNone[]

userinfoEncryptionAlgValues?

Section titled “userinfoEncryptionAlgValues?”

optional userinfoEncryptionAlgValues?: EncryptionAlgValues[]

userinfoEncryptionEncValues?

Section titled “userinfoEncryptionEncValues?”

optional userinfoEncryptionEncValues?: EncryptionEncValues[]

userinfoSigningAlgValues?

Section titled “userinfoSigningAlgValues?”

optional userinfoSigningAlgValues?: SigningAlgorithmWithNone[]

enableHttpPostMethods?

Section titled “enableHttpPostMethods?”

optional enableHttpPostMethods?: boolean

Defined in: @types/oidc-provider/index.d.ts:991

expiresWithSession?

Section titled “expiresWithSession?”

optional expiresWithSession?: (ctx, token) => CanBePromise<boolean>

Defined in: @types/oidc-provider/index.d.ts:1315

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

token
Section titled “token”

AuthorizationCode | AccessToken | DeviceCode

Returns

Section titled “Returns”

CanBePromise<boolean>

extraClientMetadata?

Section titled “extraClientMetadata?”

optional extraClientMetadata?: object

Defined in: @types/oidc-provider/index.d.ts:1385

properties?

Section titled “properties?”

optional properties?: string[]

validator?

Section titled “validator?”

optional validator?: (ctx, key, value, metadata) => void | undefined

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

key
Section titled “key”

string

value
Section titled “value”

unknown

metadata
Section titled “metadata”

ClientMetadata

Returns
Section titled “Returns”

void | undefined

extraParams?

Section titled “extraParams?”

optional extraParams?: string[] | {[param: string]: ((ctx, value, client) => CanBePromise<void>) | null; }

Defined in: @types/oidc-provider/index.d.ts:993

extraTokenClaims?

Section titled “extraTokenClaims?”

optional extraTokenClaims?: (ctx, token) => CanBePromise<UnknownObject | undefined>

Defined in: @types/oidc-provider/index.d.ts:1309

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

token
Section titled “token”

AccessToken | ClientCredentials

Returns

Section titled “Returns”

CanBePromise<UnknownObject | undefined>

features?

Section titled “features?”

optional features?: object

Defined in: @types/oidc-provider/index.d.ts:1006

attestClientAuth?

Section titled “attestClientAuth?”

optional attestClientAuth?: object

Index Signature
Section titled “Index Signature”

[key: string]: any

attestClientAuth.ack?
Section titled “attestClientAuth.ack?”

optional ack?: string

attestClientAuth.enabled?
Section titled “attestClientAuth.enabled?”

optional enabled?: boolean

backchannelLogout?

Section titled “backchannelLogout?”

optional backchannelLogout?: object

backchannelLogout.enabled?
Section titled “backchannelLogout.enabled?”

optional enabled?: boolean

ciba?

Section titled “ciba?”

optional ciba?: object

ciba.deliveryModes
Section titled “ciba.deliveryModes”

deliveryModes: CIBADeliveryMode[]

ciba.enabled?
Section titled “ciba.enabled?”

optional enabled?: boolean

ciba.processLoginHint?
Section titled “ciba.processLoginHint?”

optional processLoginHint?: (ctx, loginHint?) => CanBePromise<string | undefined>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

loginHint?
Section titled “loginHint?”

string

Returns
Section titled “Returns”

CanBePromise<string | undefined>

ciba.processLoginHintToken?
Section titled “ciba.processLoginHintToken?”

optional processLoginHintToken?: (ctx, loginHintToken?) => CanBePromise<string | undefined>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

loginHintToken?
Section titled “loginHintToken?”

string

Returns
Section titled “Returns”

CanBePromise<string | undefined>

ciba.triggerAuthenticationDevice?
Section titled “ciba.triggerAuthenticationDevice?”

optional triggerAuthenticationDevice?: (ctx, request, account, client) => CanBePromise<void>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

request
Section titled “request”

BackchannelAuthenticationRequest

account
Section titled “account”

Account

client
Section titled “client”

Client

Returns
Section titled “Returns”

CanBePromise<void>

ciba.validateBindingMessage?
Section titled “ciba.validateBindingMessage?”

optional validateBindingMessage?: (ctx, bindingMessage?) => CanBePromise<void>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

bindingMessage?
Section titled “bindingMessage?”

string

Returns
Section titled “Returns”

CanBePromise<void>

ciba.validateRequestContext?
Section titled “ciba.validateRequestContext?”

optional validateRequestContext?: (ctx, requestContext?) => CanBePromise<void>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

requestContext?
Section titled “requestContext?”

string

Returns
Section titled “Returns”

CanBePromise<void>

ciba.verifyUserCode?
Section titled “ciba.verifyUserCode?”

optional verifyUserCode?: (ctx, userCode?) => CanBePromise<void>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

userCode?
Section titled “userCode?”

string

Returns
Section titled “Returns”

CanBePromise<void>

claimsParameter?

Section titled “claimsParameter?”

optional claimsParameter?: object

claimsParameter.assertClaimsParameter?
Section titled “claimsParameter.assertClaimsParameter?”

optional assertClaimsParameter?: (ctx, claims, client) => CanBePromise<void>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

claims
Section titled “claims”

ClaimsParameter

client
Section titled “client”

Client

Returns
Section titled “Returns”

CanBePromise<void>

claimsParameter.enabled?
Section titled “claimsParameter.enabled?”

optional enabled?: boolean

clientCredentials?

Section titled “clientCredentials?”

optional clientCredentials?: object

clientCredentials.enabled?
Section titled “clientCredentials.enabled?”

optional enabled?: boolean

deviceFlow?

Section titled “deviceFlow?”

optional deviceFlow?: object

deviceFlow.charset?
Section titled “deviceFlow.charset?”

optional charset?: "base-20" | "digits"

deviceFlow.deviceInfo?
Section titled “deviceFlow.deviceInfo?”

optional deviceInfo?: (ctx) => UnknownObject

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

Returns
Section titled “Returns”

UnknownObject

deviceFlow.enabled?
Section titled “deviceFlow.enabled?”

optional enabled?: boolean

deviceFlow.mask?
Section titled “deviceFlow.mask?”

optional mask?: string

deviceFlow.successSource?
Section titled “deviceFlow.successSource?”

optional successSource?: (ctx) => CanBePromise<void | undefined>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

Returns
Section titled “Returns”

CanBePromise<void | undefined>

deviceFlow.userCodeConfirmSource?
Section titled “deviceFlow.userCodeConfirmSource?”

optional userCodeConfirmSource?: (ctx, form, client, deviceInfo, userCode) => CanBePromise<void | undefined>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

form
Section titled “form”

string

client
Section titled “client”

Client

deviceInfo
Section titled “deviceInfo”

UnknownObject

userCode
Section titled “userCode”

string

Returns
Section titled “Returns”

CanBePromise<void | undefined>

deviceFlow.userCodeInputSource?
Section titled “deviceFlow.userCodeInputSource?”

optional userCodeInputSource?: (ctx, form, out?, err?) => CanBePromise<void | undefined>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

form
Section titled “form”

string

out?
Section titled “out?”

ErrorOut

err?
Section titled “err?”

OIDCProviderError | Error

Returns
Section titled “Returns”

CanBePromise<void | undefined>

devInteractions?

Section titled “devInteractions?”

optional devInteractions?: object

devInteractions.enabled?
Section titled “devInteractions.enabled?”

optional enabled?: boolean

dPoP?

Section titled “dPoP?”

optional dPoP?: object

dPoP.allowReplay?
Section titled “dPoP.allowReplay?”

optional allowReplay?: boolean

dPoP.enabled?
Section titled “dPoP.enabled?”

optional enabled?: boolean

dPoP.nonceSecret?
Section titled “dPoP.nonceSecret?”

optional nonceSecret?: Buffer<ArrayBufferLike>

dPoP.requireNonce?
Section titled “dPoP.requireNonce?”

optional requireNonce?: (ctx) => boolean

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

Returns
Section titled “Returns”

boolean

encryption?

Section titled “encryption?”

optional encryption?: object

encryption.enabled?
Section titled “encryption.enabled?”

optional enabled?: boolean

externalSigningSupport?

Section titled “externalSigningSupport?”

optional externalSigningSupport?: object

Index Signature
Section titled “Index Signature”

[key: string]: any

externalSigningSupport.ack?
Section titled “externalSigningSupport.ack?”

optional ack?: string

externalSigningSupport.enabled?
Section titled “externalSigningSupport.enabled?”

optional enabled?: boolean

fapi?

Section titled “fapi?”

optional fapi?: object

fapi.enabled?
Section titled “fapi.enabled?”

optional enabled?: boolean

fapi.profile
Section titled “fapi.profile”

profile: FapiProfile | ((ctx, client) => FapiProfile) | undefined

introspection?

Section titled “introspection?”

optional introspection?: object

introspection.allowedPolicy?
Section titled “introspection.allowedPolicy?”

optional allowedPolicy?: (ctx, client, token) => CanBePromise<boolean>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

client
Section titled “client”

Client

token
Section titled “token”

AccessToken | ClientCredentials | RefreshToken

Returns
Section titled “Returns”

CanBePromise<boolean>

introspection.enabled?
Section titled “introspection.enabled?”

optional enabled?: boolean

jwtIntrospection?

Section titled “jwtIntrospection?”

optional jwtIntrospection?: object

jwtIntrospection.enabled?
Section titled “jwtIntrospection.enabled?”

optional enabled?: boolean

jwtResponseModes?

Section titled “jwtResponseModes?”

optional jwtResponseModes?: object

jwtResponseModes.enabled?
Section titled “jwtResponseModes.enabled?”

optional enabled?: boolean

jwtUserinfo?

Section titled “jwtUserinfo?”

optional jwtUserinfo?: object

jwtUserinfo.enabled?
Section titled “jwtUserinfo.enabled?”

optional enabled?: boolean

mTLS?

Section titled “mTLS?”

optional mTLS?: object

mTLS.certificateAuthorized?
Section titled “mTLS.certificateAuthorized?”

optional certificateAuthorized?: (ctx) => boolean

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

Returns
Section titled “Returns”

boolean

mTLS.certificateBoundAccessTokens?
Section titled “mTLS.certificateBoundAccessTokens?”

optional certificateBoundAccessTokens?: boolean

mTLS.certificateSubjectMatches?
Section titled “mTLS.certificateSubjectMatches?”

optional certificateSubjectMatches?: (ctx, property, expected) => boolean

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

property
Section titled “property”

TLSClientAuthProperty

expected
Section titled “expected”

string

Returns
Section titled “Returns”

boolean

mTLS.enabled?
Section titled “mTLS.enabled?”

optional enabled?: boolean

mTLS.getCertificate?
Section titled “mTLS.getCertificate?”

optional getCertificate?: (ctx) => string | X509Certificate | undefined

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

Returns
Section titled “Returns”

string | X509Certificate | undefined

mTLS.selfSignedTlsClientAuth?
Section titled “mTLS.selfSignedTlsClientAuth?”

optional selfSignedTlsClientAuth?: boolean

mTLS.tlsClientAuth?
Section titled “mTLS.tlsClientAuth?”

optional tlsClientAuth?: boolean

pushedAuthorizationRequests?

Section titled “pushedAuthorizationRequests?”

optional pushedAuthorizationRequests?: object

pushedAuthorizationRequests.allowUnregisteredRedirectUris?
Section titled “pushedAuthorizationRequests.allowUnregisteredRedirectUris?”

optional allowUnregisteredRedirectUris?: boolean

pushedAuthorizationRequests.enabled?
Section titled “pushedAuthorizationRequests.enabled?”

optional enabled?: boolean

pushedAuthorizationRequests.requirePushedAuthorizationRequests?
Section titled “pushedAuthorizationRequests.requirePushedAuthorizationRequests?”

optional requirePushedAuthorizationRequests?: boolean

registration?

Section titled “registration?”

optional registration?: object

registration.enabled?
Section titled “registration.enabled?”

optional enabled?: boolean

registration.idFactory?
Section titled “registration.idFactory?”

optional idFactory?: (ctx) => string

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

Returns
Section titled “Returns”

string

registration.initialAccessToken?
Section titled “registration.initialAccessToken?”

optional initialAccessToken?: string | boolean

registration.issueRegistrationAccessToken?
Section titled “registration.issueRegistrationAccessToken?”

optional issueRegistrationAccessToken?: boolean | IssueRegistrationAccessTokenFunction

registration.policies?
Section titled “registration.policies?”

optional policies?: object

Index Signature
Section titled “Index Signature”

[key: string]: (ctx, metadata) => CanBePromise<void | undefined>

registration.secretFactory?
Section titled “registration.secretFactory?”

optional secretFactory?: (ctx) => string

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

Returns
Section titled “Returns”

string

registrationManagement?

Section titled “registrationManagement?”

optional registrationManagement?: object

registrationManagement.enabled?
Section titled “registrationManagement.enabled?”

optional enabled?: boolean

registrationManagement.rotateRegistrationAccessToken?
Section titled “registrationManagement.rotateRegistrationAccessToken?”

optional rotateRegistrationAccessToken?: boolean | RotateRegistrationAccessTokenFunction

requestObjects?

Section titled “requestObjects?”

optional requestObjects?: object

requestObjects.assertJwtClaimsAndHeader?
Section titled “requestObjects.assertJwtClaimsAndHeader?”

optional assertJwtClaimsAndHeader?: (ctx, claims, header, client) => CanBePromise<void>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

claims
Section titled “claims”

Record<string, JsonValue>

header
Section titled “header”

Record<string, JsonValue>

client
Section titled “client”

Client

Returns
Section titled “Returns”

CanBePromise<void>

requestObjects.enabled?
Section titled “requestObjects.enabled?”

optional enabled?: boolean

requestObjects.requireSignedRequestObject?
Section titled “requestObjects.requireSignedRequestObject?”

optional requireSignedRequestObject?: boolean

resourceIndicators?

Section titled “resourceIndicators?”

optional resourceIndicators?: object

resourceIndicators.defaultResource?
Section titled “resourceIndicators.defaultResource?”

optional defaultResource?: (ctx, client, oneOf?) => CanBePromise<string | string[]>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

client
Section titled “client”

Client

oneOf?
Section titled “oneOf?”

string[]

Returns
Section titled “Returns”

CanBePromise<string | string[]>

resourceIndicators.enabled?
Section titled “resourceIndicators.enabled?”

optional enabled?: boolean

resourceIndicators.getResourceServerInfo?
Section titled “resourceIndicators.getResourceServerInfo?”

optional getResourceServerInfo?: (ctx, resourceIndicator, client) => CanBePromise<ResourceServer>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

resourceIndicator
Section titled “resourceIndicator”

string

client
Section titled “client”

Client

Returns
Section titled “Returns”

CanBePromise<ResourceServer>

resourceIndicators.useGrantedResource?
Section titled “resourceIndicators.useGrantedResource?”

optional useGrantedResource?: (ctx, model) => CanBePromise<boolean>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

model
Section titled “model”

AuthorizationCode | DeviceCode | BackchannelAuthenticationRequest | RefreshToken

Returns
Section titled “Returns”

CanBePromise<boolean>

revocation?

Section titled “revocation?”

optional revocation?: object

revocation.allowedPolicy?
Section titled “revocation.allowedPolicy?”

optional allowedPolicy?: (ctx, client, token) => CanBePromise<boolean>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

client
Section titled “client”

Client

token
Section titled “token”

AccessToken | ClientCredentials | RefreshToken

Returns
Section titled “Returns”

CanBePromise<boolean>

revocation.enabled?
Section titled “revocation.enabled?”

optional enabled?: boolean

richAuthorizationRequests?

Section titled “richAuthorizationRequests?”

optional richAuthorizationRequests?: object

Index Signature
Section titled “Index Signature”

[key: string]: any

richAuthorizationRequests.ack?
Section titled “richAuthorizationRequests.ack?”

optional ack?: string

richAuthorizationRequests.enabled?
Section titled “richAuthorizationRequests.enabled?”

optional enabled?: boolean

rpInitiatedLogout?

Section titled “rpInitiatedLogout?”

optional rpInitiatedLogout?: object

rpInitiatedLogout.enabled?
Section titled “rpInitiatedLogout.enabled?”

optional enabled?: boolean

rpInitiatedLogout.logoutSource?
Section titled “rpInitiatedLogout.logoutSource?”

optional logoutSource?: (ctx, form) => CanBePromise<void | undefined>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

form
Section titled “form”

string

Returns
Section titled “Returns”

CanBePromise<void | undefined>

rpInitiatedLogout.postLogoutSuccessSource?
Section titled “rpInitiatedLogout.postLogoutSuccessSource?”

optional postLogoutSuccessSource?: (ctx) => CanBePromise<void | undefined>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

Returns
Section titled “Returns”

CanBePromise<void | undefined>

rpMetadataChoices?

Section titled “rpMetadataChoices?”

optional rpMetadataChoices?: object

Index Signature
Section titled “Index Signature”

[key: string]: any

rpMetadataChoices.ack?
Section titled “rpMetadataChoices.ack?”

optional ack?: string

rpMetadataChoices.enabled?
Section titled “rpMetadataChoices.enabled?”

optional enabled?: boolean

userinfo?

Section titled “userinfo?”

optional userinfo?: object

userinfo.enabled?
Section titled “userinfo.enabled?”

optional enabled?: boolean

webMessageResponseMode?

Section titled “webMessageResponseMode?”

optional webMessageResponseMode?: object

webMessageResponseMode.ack?
Section titled “webMessageResponseMode.ack?”

optional ack?: string

webMessageResponseMode.enabled?
Section titled “webMessageResponseMode.enabled?”

optional enabled?: boolean

fetch?

Section titled “fetch?”

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: @types/oidc-provider/index.d.ts:1313

Call Signature

Section titled “Call Signature”

(input, init?): Promise<Response>

MDN Reference

Parameters
Section titled “Parameters”
input
Section titled “input”

RequestInfo | URL

init?
Section titled “init?”

RequestInit

Returns
Section titled “Returns”

Promise<Response>

Call Signature

Section titled “Call Signature”

(input, init?): Promise<Response>

MDN Reference

Parameters
Section titled “Parameters”
input
Section titled “input”

string | Request | URL

init?
Section titled “init?”

RequestInit

Returns
Section titled “Returns”

Promise<Response>

findAccount?

Section titled “findAccount?”

optional findAccount?: FindAccount

Defined in: @types/oidc-provider/index.d.ts:1422

formats?

Section titled “formats?”

optional formats?: object

Defined in: @types/oidc-provider/index.d.ts:950

bitsOfOpaqueRandomness?

Section titled “bitsOfOpaqueRandomness?”

optional bitsOfOpaqueRandomness?: number | ((ctx, model) => number)

customizers?

Section titled “customizers?”

optional customizers?: object

customizers.jwt?
Section titled “customizers.jwt?”

optional jwt?: (ctx, token, parts) => CanBePromise<JWTStructured>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

token
Section titled “token”

AccessToken | ClientCredentials

parts
Section titled “parts”

JWTStructured

Returns
Section titled “Returns”

CanBePromise<JWTStructured>

interactions?

Section titled “interactions?”

optional interactions?: object

Defined in: @types/oidc-provider/index.d.ts:1415

policy?

Section titled “policy?”

optional policy?: Prompt[]

url?

Section titled “url?”

optional url?: (ctx, interaction) => CanBePromise<string>

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

interaction
Section titled “interaction”

Interaction

Returns
Section titled “Returns”

CanBePromise<string>

issueRefreshToken?

Section titled “issueRefreshToken?”

optional issueRefreshToken?: (ctx, client, code) => CanBePromise<boolean>

Defined in: @types/oidc-provider/index.d.ts:1319

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

client
Section titled “client”

Client

code
Section titled “code”

AuthorizationCode | DeviceCode | BackchannelAuthenticationRequest

Returns

Section titled “Returns”

CanBePromise<boolean>

jwks?

Section titled “jwks?”

optional jwks?: JWKS

Defined in: @types/oidc-provider/index.d.ts:1327

loadExistingGrant?

Section titled “loadExistingGrant?”

optional loadExistingGrant?: (ctx) => CanBePromise<Grant | undefined>

Defined in: @types/oidc-provider/index.d.ts:1383

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

Returns

Section titled “Returns”

CanBePromise<Grant | undefined>

pairwiseIdentifier?

Section titled “pairwiseIdentifier?”

optional pairwiseIdentifier?: (ctx, accountId, client) => CanBePromise<string>

Defined in: @types/oidc-provider/index.d.ts:1360

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

accountId
Section titled “accountId”

string

client
Section titled “client”

Client

Returns

Section titled “Returns”

CanBePromise<string>

pkce?

Section titled “pkce?”

optional pkce?: object

Defined in: @types/oidc-provider/index.d.ts:1333

required?

Section titled “required?”

optional required?: (ctx, client) => boolean

Parameters
Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

client
Section titled “client”

Client

Returns
Section titled “Returns”

boolean

renderError?

Section titled “renderError?”

optional renderError?: (ctx, out, error) => CanBePromise<void | undefined>

Defined in: @types/oidc-provider/index.d.ts:1403

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

out
Section titled “out”

ErrorOut

error
Section titled “error”

OIDCProviderError | Error

Returns

Section titled “Returns”

CanBePromise<void | undefined>

responseTypes?

Section titled “responseTypes?”

optional responseTypes?: ResponseType[]

Defined in: @types/oidc-provider/index.d.ts:1329

revokeGrantPolicy?

Section titled “revokeGrantPolicy?”

optional revokeGrantPolicy?: (ctx) => boolean

Defined in: @types/oidc-provider/index.d.ts:1331

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

KoaContextWithOIDC

Returns

Section titled “Returns”

boolean

rotateRefreshToken?

Section titled “rotateRefreshToken?”

optional rotateRefreshToken?: boolean | ((ctx) => CanBePromise<boolean>)

Defined in: @types/oidc-provider/index.d.ts:1401

routes?

Section titled “routes?”

optional routes?: object

Defined in: @types/oidc-provider/index.d.ts:1339

authorization?

Section titled “authorization?”

optional authorization?: string

backchannel_authentication?

Section titled “backchannel_authentication?”

optional backchannel_authentication?: string

code_verification?

Section titled “code_verification?”

optional code_verification?: string

device_authorization?

Section titled “device_authorization?”

optional device_authorization?: string

end_session?

Section titled “end_session?”

optional end_session?: string

introspection?

Section titled “introspection?”

optional introspection?: string

jwks?

Section titled “jwks?”

optional jwks?: string

pushed_authorization_request?

Section titled “pushed_authorization_request?”

optional pushed_authorization_request?: string

registration?

Section titled “registration?”

optional registration?: string

revocation?

Section titled “revocation?”

optional revocation?: string

token?

Section titled “token?”

optional token?: string

userinfo?

Section titled “userinfo?”

optional userinfo?: string

scopes?

Section titled “scopes?”

optional scopes?: string[]

Defined in: @types/oidc-provider/index.d.ts:1356

subjectTypes?

Section titled “subjectTypes?”

optional subjectTypes?: SubjectTypes[]

Defined in: @types/oidc-provider/index.d.ts:1358

ttl?

Section titled “ttl?”

optional ttl?: object

Defined in: @types/oidc-provider/index.d.ts:1366

Index Signature

Section titled “Index Signature”

[key: string]: unknown

AccessToken?

Section titled “AccessToken?”

optional AccessToken?: number | TTLFunction<AccessToken>

AuthorizationCode?

Section titled “AuthorizationCode?”

optional AuthorizationCode?: number | TTLFunction<AuthorizationCode>

BackchannelAuthenticationRequest?

Section titled “BackchannelAuthenticationRequest?”

optional BackchannelAuthenticationRequest?: number | TTLFunction<BackchannelAuthenticationRequest>

ClientCredentials?

Section titled “ClientCredentials?”

optional ClientCredentials?: number | TTLFunction<ClientCredentials>

DeviceCode?

Section titled “DeviceCode?”

optional DeviceCode?: number | TTLFunction<DeviceCode>

Grant?

Section titled “Grant?”

optional Grant?: number | TTLFunction<Grant>

IdToken?

Section titled “IdToken?”

optional IdToken?: number | TTLFunction<IdToken>

Interaction?

Section titled “Interaction?”

optional Interaction?: number | TTLFunction<Interaction>

RefreshToken?

Section titled “RefreshToken?”

optional RefreshToken?: number | TTLFunction<RefreshToken>

Session?

Section titled “Session?”

optional Session?: number | TTLFunction<Session>