Class OAuth2LoginProvider<TConfig>`Abstract`

LoginProvider implementation for OAuth2-based logins.

Type Parameters

TConfig extends OAuth2LoginProviderConfig

Hierarchy

LoginProvider<TConfig>
- OAuth2LoginProvider
  - CoreIDLoginProvider

Index

Constructors

Properties

config name request routing

Accessors

Methods

callback getLoginUrl handleCallback login logout redirectToIntendedRoute registration routes

Constructors

constructor

new OAuth2LoginProvider<TConfig>(name: string, config: TConfig): OAuth2LoginProvider<TConfig>
Type Parameters
- TConfig extends OAuth2LoginProviderConfig
Parameters
- name: string
- config: TConfig
Returns OAuth2LoginProvider<TConfig>
Inherited from LoginProvider<TConfig>.constructor
- Defined in src/auth/provider/LoginProvider.ts:28

Properties

`Protected` config

config: TConfig

`Protected` name

name: string

`Protected` `Readonly` request

request: RequestLocalStorage

`Protected` `Readonly` routing

routing: Routing

Accessors

`Protected` security

get security(): SecurityContext
Returns SecurityContext
Inherited from LoginProvider.security
- Defined in src/auth/provider/LoginProvider.ts:24

Methods

`Protected` `Abstract` callback

callback(request: Request): Awaitable<Authenticatable>
Protected
After redirecting back from the OAuth2 server, look up the user information.
Parameters
- request: Request
Returns Awaitable<Authenticatable>
- Defined in src/auth/provider/oauth/OAuth2LoginProvider.ts:61

`Protected` getLoginUrl

getLoginUrl(): string
Protected
Get the URL where the user should be redirected to sign-in.

Returns string
- Defined in src/auth/provider/oauth/OAuth2LoginProvider.ts:91

`Protected` handleCallback

handleCallback(request: Request): Promise<any>
Parameters
- request: Request
Returns Promise<any>
- Defined in src/auth/provider/oauth/OAuth2LoginProvider.ts:46

login

login(): any
Returns any
Overrides LoginProvider.login
- Defined in src/auth/provider/oauth/OAuth2LoginProvider.ts:63

logout

logout(): Promise<any>
Returns Promise<any>
Overrides LoginProvider.logout
- Defined in src/auth/provider/oauth/OAuth2LoginProvider.ts:75

`Protected` redirectToIntendedRoute

redirectToIntendedRoute(): any
Returns any
Inherited from LoginProvider.redirectToIntendedRoute
- Defined in src/auth/provider/LoginProvider.ts:64

registration

registration(request: Request): any
Parameters
- request: Request
Returns any
Inherited from LoginProvider.registration
- Defined in src/auth/provider/LoginProvider.ts:60

routes

routes(): void
Returns void
Overrides LoginProvider.routes
- Defined in src/auth/provider/oauth/OAuth2LoginProvider.ts:31