Skip to content
oidc-provider

Client

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

Indexable

Section titled “Indexable”

[key: string]: unknown

Properties

Section titled “Properties”

applicationType?

Section titled “applicationType?”

readonly optional applicationType?: "web" | "native"

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

authorizationEncryptedResponseAlg?

Section titled “authorizationEncryptedResponseAlg?”

readonly optional authorizationEncryptedResponseAlg?: string

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

authorizationEncryptedResponseEnc?

Section titled “authorizationEncryptedResponseEnc?”

readonly optional authorizationEncryptedResponseEnc?: string

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

authorizationSignedResponseAlg?

Section titled “authorizationSignedResponseAlg?”

readonly optional authorizationSignedResponseAlg?: string

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

backchannelAuthenticationRequestSigningAlg?

Section titled “backchannelAuthenticationRequestSigningAlg?”

readonly optional backchannelAuthenticationRequestSigningAlg?: string

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

backchannelClientNotificationEndpoint?

Section titled “backchannelClientNotificationEndpoint?”

readonly optional backchannelClientNotificationEndpoint?: string

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

backchannelLogoutSessionRequired?

Section titled “backchannelLogoutSessionRequired?”

readonly optional backchannelLogoutSessionRequired?: boolean

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

backchannelLogoutUri?

Section titled “backchannelLogoutUri?”

readonly optional backchannelLogoutUri?: string

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

backchannelTokenDeliveryMode?

Section titled “backchannelTokenDeliveryMode?”

readonly optional backchannelTokenDeliveryMode?: CIBADeliveryMode

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

backchannelUserCodeParameter?

Section titled “backchannelUserCodeParameter?”

readonly optional backchannelUserCodeParameter?: boolean

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

clientAuthMethod?

Section titled “clientAuthMethod?”

readonly optional clientAuthMethod?: string

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

clientAuthSigningAlg?

Section titled “clientAuthSigningAlg?”

readonly optional clientAuthSigningAlg?: string

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

clientId

Section titled “clientId”

readonly clientId: string

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

clientIdIssuedAt?

Section titled “clientIdIssuedAt?”

readonly optional clientIdIssuedAt?: number

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

clientName?

Section titled “clientName?”

readonly optional clientName?: string

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

clientSecret?

Section titled “clientSecret?”

readonly optional clientSecret?: string

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

clientSecretExpiresAt?

Section titled “clientSecretExpiresAt?”

readonly optional clientSecretExpiresAt?: number

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

clientUri?

Section titled “clientUri?”

readonly optional clientUri?: string

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

contacts?

Section titled “contacts?”

readonly optional contacts?: string[]

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

defaultAcrValues?

Section titled “defaultAcrValues?”

readonly optional defaultAcrValues?: string[]

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

defaultMaxAge?

Section titled “defaultMaxAge?”

readonly optional defaultMaxAge?: number

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

grantTypes?

Section titled “grantTypes?”

readonly optional grantTypes?: string[]

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

idTokenEncryptedResponseAlg?

Section titled “idTokenEncryptedResponseAlg?”

readonly optional idTokenEncryptedResponseAlg?: string

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

idTokenEncryptedResponseEnc?

Section titled “idTokenEncryptedResponseEnc?”

readonly optional idTokenEncryptedResponseEnc?: string

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

idTokenSignedResponseAlg?

Section titled “idTokenSignedResponseAlg?”

readonly optional idTokenSignedResponseAlg?: string

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

initiateLoginUri?

Section titled “initiateLoginUri?”

readonly optional initiateLoginUri?: string

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

introspectionEncryptedResponseAlg?

Section titled “introspectionEncryptedResponseAlg?”

readonly optional introspectionEncryptedResponseAlg?: string

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

introspectionEncryptedResponseEnc?

Section titled “introspectionEncryptedResponseEnc?”

readonly optional introspectionEncryptedResponseEnc?: string

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

introspectionSignedResponseAlg?

Section titled “introspectionSignedResponseAlg?”

readonly optional introspectionSignedResponseAlg?: string

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

jwks?

Section titled “jwks?”

readonly optional jwks?: JWKS

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

jwksUri?

Section titled “jwksUri?”

readonly optional jwksUri?: string

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

logoUri?

Section titled “logoUri?”

readonly optional logoUri?: string

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

policyUri?

Section titled “policyUri?”

readonly optional policyUri?: string

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

postLogoutRedirectUris?

Section titled “postLogoutRedirectUris?”

readonly optional postLogoutRedirectUris?: string[]

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

redirectUris?

Section titled “redirectUris?”

readonly optional redirectUris?: string[]

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

requestObjectEncryptionAlg?

Section titled “requestObjectEncryptionAlg?”

readonly optional requestObjectEncryptionAlg?: string

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

requestObjectEncryptionEnc?

Section titled “requestObjectEncryptionEnc?”

readonly optional requestObjectEncryptionEnc?: string

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

requestObjectSigningAlg?

Section titled “requestObjectSigningAlg?”

readonly optional requestObjectSigningAlg?: string

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

requireAuthTime?

Section titled “requireAuthTime?”

readonly optional requireAuthTime?: boolean

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

responseModes?

Section titled “responseModes?”

readonly optional responseModes?: string[]

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

responseTypes?

Section titled “responseTypes?”

readonly optional responseTypes?: ResponseType[]

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

scope?

Section titled “scope?”

readonly optional scope?: string

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

sectorIdentifierUri?

Section titled “sectorIdentifierUri?”

readonly optional sectorIdentifierUri?: string

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

subjectType?

Section titled “subjectType?”

readonly optional subjectType?: SubjectTypes

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

tlsClientAuthSanDns?

Section titled “tlsClientAuthSanDns?”

readonly optional tlsClientAuthSanDns?: string

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

tlsClientAuthSanEmail?

Section titled “tlsClientAuthSanEmail?”

readonly optional tlsClientAuthSanEmail?: string

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

tlsClientAuthSanIp?

Section titled “tlsClientAuthSanIp?”

readonly optional tlsClientAuthSanIp?: string

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

tlsClientAuthSanUri?

Section titled “tlsClientAuthSanUri?”

readonly optional tlsClientAuthSanUri?: string

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

tlsClientAuthSubjectDn?

Section titled “tlsClientAuthSubjectDn?”

readonly optional tlsClientAuthSubjectDn?: string

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

tlsClientCertificateBoundAccessTokens?

Section titled “tlsClientCertificateBoundAccessTokens?”

readonly optional tlsClientCertificateBoundAccessTokens?: boolean

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

tokenEndpointAuthMethod?

Section titled “tokenEndpointAuthMethod?”

readonly optional tokenEndpointAuthMethod?: string

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

tokenEndpointAuthSigningAlg?

Section titled “tokenEndpointAuthSigningAlg?”

readonly optional tokenEndpointAuthSigningAlg?: string

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

tosUri?

Section titled “tosUri?”

readonly optional tosUri?: string

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

userinfoEncryptedResponseAlg?

Section titled “userinfoEncryptedResponseAlg?”

readonly optional userinfoEncryptedResponseAlg?: string

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

userinfoEncryptedResponseEnc?

Section titled “userinfoEncryptedResponseEnc?”

readonly optional userinfoEncryptedResponseEnc?: string

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

userinfoSignedResponseAlg?

Section titled “userinfoSignedResponseAlg?”

readonly optional userinfoSignedResponseAlg?: string

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

Methods

Section titled “Methods”

backchannelPing()

Section titled “backchannelPing()”

backchannelPing(request): Promise<void>

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

Parameters

Section titled “Parameters”
request
Section titled “request”

BackchannelAuthenticationRequest

Returns

Section titled “Returns”

Promise<void>

compareClientSecret()

Section titled “compareClientSecret()”

compareClientSecret(actual): CanBePromise<boolean>

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

Parameters

Section titled “Parameters”
actual
Section titled “actual”

string

Returns

Section titled “Returns”

CanBePromise<boolean>

grantTypeAllowed()

Section titled “grantTypeAllowed()”

grantTypeAllowed(type): boolean

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

Parameters

Section titled “Parameters”
type
Section titled “type”

string

Returns

Section titled “Returns”

boolean

includeSid()

Section titled “includeSid()”

includeSid(): boolean

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

Returns

Section titled “Returns”

boolean

metadata()

Section titled “metadata()”

metadata(): ClientMetadata

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

Returns

Section titled “Returns”

ClientMetadata

postLogoutRedirectUriAllowed()

Section titled “postLogoutRedirectUriAllowed()”

postLogoutRedirectUriAllowed(postLogoutRedirectUri): boolean

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

Parameters

Section titled “Parameters”
postLogoutRedirectUri
Section titled “postLogoutRedirectUri”

string

Returns

Section titled “Returns”

boolean

redirectUriAllowed()

Section titled “redirectUriAllowed()”

redirectUriAllowed(redirectUri): boolean

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

Parameters

Section titled “Parameters”
redirectUri
Section titled “redirectUri”

string

Returns

Section titled “Returns”

boolean

responseModeAllowed()

Section titled “responseModeAllowed()”

responseModeAllowed(type, responseType, fapiProfile): boolean

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

Parameters

Section titled “Parameters”
type
Section titled “type”

string

responseType
Section titled “responseType”

ResponseType

fapiProfile
Section titled “fapiProfile”

FapiProfile | undefined

Returns

Section titled “Returns”

boolean

responseTypeAllowed()

Section titled “responseTypeAllowed()”

responseTypeAllowed(type): boolean

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

Parameters

Section titled “Parameters”
type
Section titled “type”

ResponseType

Returns

Section titled “Returns”

boolean