Class CoreIDLoginProvider

OAuth2LoginProvider implementation that authenticates users against a Starship CoreID server.

Hierarchy

OAuth2LoginProvider<OAuth2LoginProviderConfig>
- CoreIDLoginProvider

Index

Constructors

Properties

config name request routing

Accessors

Methods

callback getLoginUrl getToken getUserData handleCallback login logout redirectToIntendedRoute registration routes updateUser

Constructors

constructor

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

Properties

`Protected` config

config: OAuth2LoginProviderConfig

`Protected` name

name: string

`Protected` `Readonly` request

request: RequestLocalStorage

`Protected` `Readonly` routing

routing: Routing

Accessors

`Protected` security

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

Methods

`Protected` callback

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

`Protected` getLoginUrl

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

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

`Protected` getToken

getToken(code: string): Promise<string>
Given a login code, redeem it for an access token.
Parameters
- code: string
Returns Promise<string>
- Defined in src/auth/provider/oauth/CoreIDLoginProvider.ts:57

`Protected` getUserData

getUserData(token: string): Promise<any>
Given an access token, look up the associated user's information.
Parameters
- token: string
Returns Promise<any>
- Defined in src/auth/provider/oauth/CoreIDLoginProvider.ts:35

`Protected` handleCallback

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

login

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

logout

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

`Protected` redirectToIntendedRoute

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

registration

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

routes

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

`Protected` updateUser

updateUser(user: any, data: any): void
Update values on the Authenticatable from user data.
Parameters
- user: any
- data: any
Returns void
- Defined in src/auth/provider/oauth/CoreIDLoginProvider.ts:89