Class OidcAuthenticationProvider

Hierarchy (View Summary)

OAuth2AuthenticationProvider
- OidcAuthenticationProvider

Constructors

constructor

new OidcAuthenticationProvider(): OidcAuthenticationProvider

Returns OidcAuthenticationProvider

Inherited from OAuth2AuthenticationProvider.constructor

Properties

`Protected` `Readonly`authorizationCodeTokenResponseClient

authorizationCodeTokenResponseClient: AuthorizationCodeTokenResponseClient

`Protected` `Readonly`authorizationRequestManager

authorizationRequestManager: AuthorizationRequestManager<AuthorizationRequest>

`Protected` `Readonly`authorizedClientManager

authorizedClientManager: AuthorizedClientManager<AuthorizedClient>

`Protected` `Readonly`clientRegistrationManager

clientRegistrationManager: ClientRegistrationManager

`Protected` `Readonly`endpoint

endpoint: string

`Protected` `Readonly`idTokenJwtDecoderFactory

idTokenJwtDecoderFactory: IdTokenJwtDecoderFactory

`Protected` `Readonly`options

options: any

`Protected` `Readonly`pathResolver

pathResolver: PathResolver

priority

priority: any = OIDC_AUTHENTICATION_PROVIDER_PRIORITY

`Protected` `Readonly`requestMatcher

requestMatcher: RequestMatcher

`Protected` `Readonly`userChecker

userChecker: UserChecker

`Protected` `Readonly`userMapper

userMapper: UserMapper

`Protected` `Readonly`userService

userService: UserService<OidcUserRequest, User>

Methods

authenticate

authenticate(): Promise<OAuth2LoginAuthentication | undefined>
Returns Promise<OAuth2LoginAuthentication | undefined>
Inherited from OAuth2AuthenticationProvider.authenticate
- Defined in authentication/oauth2-authentication-provider.ts:76

`Protected`checkScopes

checkScopes(scopes: string[]): boolean
Parameters
- scopes: string[]
Returns boolean
Overrides OAuth2AuthenticationProvider.checkScopes
- Defined in authentication/oidc-authentication-provider.ts:24

`Protected`createOidcToken

createOidcToken(
clientRegistration: ClientRegistration,
tokenResponse: AccessTokenResponse,
): Promise<Jwt>
Parameters
- clientRegistration: ClientRegistration
- tokenResponse: AccessTokenResponse
Returns Promise<Jwt>
- Defined in authentication/oidc-authentication-provider.ts:67

`Protected`getUserinfo

getUserinfo(
    clientRegistration: ClientRegistration,
    tokenResponse: AccessTokenResponse,
    additionalParameters: { [key: string]: string },
    authorizationRequest: AuthorizationRequest,
): Promise<any>
Parameters
- clientRegistration: ClientRegistration
- tokenResponse: AccessTokenResponse
- additionalParameters: { [key: string]: string }
- authorizationRequest: AuthorizationRequest
Returns Promise<any>
Overrides OAuth2AuthenticationProvider.getUserinfo
- Defined in authentication/oidc-authentication-provider.ts:36

support

support(): Promise<boolean>
Returns Promise<boolean>
Inherited from OAuth2AuthenticationProvider.support
- Defined in authentication/oauth2-authentication-provider.ts:160

`Protected`validateNonce

validateNonce(authorizationRequest: AuthorizationRequest, idToken: Jwt): void
OpenID Connect Core 1.0 §3.1.3.7: when the authorization request sent a nonce, the ID Token must carry it back (as sent, the hash of the stored nonce).
Parameters
- authorizationRequest: AuthorizationRequest
- idToken: Jwt
Returns void
- Defined in authentication/oidc-authentication-provider.ts:53