Class AuthContext

Hierarchy

AuthContext

Index

Constructors

Methods

acquireToken getAccount getCachedTokenForResource isAuthenticated login logout

Constructors

constructor

new AuthContext(provider: WebAppAuthProvider, context: RequestContext): AuthContext
Parameters
- provider: WebAppAuthProvider
- context: RequestContext
Returns AuthContext
- Defined in middleware/context/AuthContext.ts:21

Methods

acquireToken

acquireToken(options?: TokenRequestOptions): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
Acquires an access token for given request parameters

Returns
Parameters
- options: TokenRequestOptions = ...
Returns RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- Defined in middleware/context/AuthContext.ts:60

getAccount

getAccount(): undefined | AccountInfo
Returns the current user account from session

Returns
account object

Returns undefined | AccountInfo
- Defined in middleware/context/AuthContext.ts:70

getCachedTokenForResource

getCachedTokenForResource(resourceName: string): null | string
Returns the cached token for a given resource

Returns
cached access token
Parameters
- resourceName: string
Returns null | string
- Defined in middleware/context/AuthContext.ts:87

isAuthenticated

isAuthenticated(): boolean
Returns true if session contains user account

Returns
authentication status

Returns boolean
- Defined in middleware/context/AuthContext.ts:78

login

login(options?: LoginOptions): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
Initiates a login flow with given options

Returns
Parameters
- options: LoginOptions = ...
Returns RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- Defined in middleware/context/AuthContext.ts:31

logout

logout(options?: LogoutOptions): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
Initiates a logout flow and destroys the current session

Returns
Parameters
- options: LogoutOptions = ...
Returns RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- Defined in middleware/context/AuthContext.ts:46

Generated using TypeDoc