Class OAuth2LoginProvider<TConfig>

LoginProvider implementation for OAuth2-based logins.

Type parameters

TConfig: OAuth2LoginProviderConfig

Hierarchy

LoginProvider<TConfig>
- OAuth2LoginProvider
  - CoreIDLoginProvider

Index

Constructors

constructor

Properties

Accessors

security

Methods

Constructors

constructor

new OAuth2LoginProvider<TConfig>(name: string, config: TConfig): OAuth2LoginProvider<TConfig>

Inherited from LoginProvider<TConfig>.constructor
- Defined in src/auth/provider/LoginProvider.ts:26
Type parameters
- TConfig: OAuth2LoginProviderConfig
Parameters
- name: string
- config: TConfig
Returns OAuth2LoginProvider<TConfig>

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

- Defined in src/auth/provider/LoginProvider.ts:24
Returns SecurityContext

Methods

Protected Abstract callback

callback(request: Request): Awaitable<Authenticatable>

- Defined in src/auth/provider/oauth/OAuth2LoginProvider.ts:61
After redirecting back from the OAuth2 server, look up the user information.

Parameters
- request: Request
Returns Awaitable<Authenticatable>

Protected getLoginUrl

getLoginUrl(): string

- Defined in src/auth/provider/oauth/OAuth2LoginProvider.ts:91
Get the URL where the user should be redirected to sign-in.

Returns string

Protected handleCallback

handleCallback(request: Request): Promise<any>

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

login

login(): any

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

logout

logout(): Promise<any>

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

Protected redirectToIntendedRoute

redirectToIntendedRoute(): any

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

registration

registration(request: Request): any

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

routes

routes(): void

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

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.