ServerAdapter | auth-toolbox

Adapts HTTP authentication server to common objects like ServerEndpoint and Request.

It supports creating login, renew and logout requests based on supported protocol (OAuth, OpenID, custom JWT authentication ...).

It also supports setting the access token on any Request, reading Tokens from Response, and checking if Tokens.access or Tokens.refresh have expired from Response.

Implementation of this interface can be given to Auth constructor.

Type parameters

C = UsernamePasswordCredentials

Credentials type

Hierarchy

ServerAdapter

Implemented by

Index

Methods

Methods

accessTokenHasExpired

accessTokenHasExpired(request: Request, response: Response): boolean

- Defined in auth-toolbox.ts:385
Check if access token has expired from Response.

Parameters
- request: Request
  
  initial request that leads to the received response
- response: Response
  
  received response
Returns boolean

asLoginRequest

asLoginRequest(loginEndpoint: ServerEndpoint, credentials: C): Request

- Defined in auth-toolbox.ts:344
Build a login Request (with credentials).

Parameters
- loginEndpoint: ServerEndpoint
- credentials: C
Returns Request

asLogoutRequest

asLogoutRequest(logoutEndpoint: ServerEndpoint, refreshToken: Token): Request

- Defined in auth-toolbox.ts:360
Build a logout Request (with refresh token).

Parameters
- logoutEndpoint: ServerEndpoint
- refreshToken: Token
Returns Request

asRenewRequest

asRenewRequest(renewEndpoint: ServerEndpoint, refreshToken: Token): Request

- Defined in auth-toolbox.ts:352
Build a renew Request (with refresh token).

Parameters
- renewEndpoint: ServerEndpoint
- refreshToken: Token
Returns Request

getResponseTokens

getResponseTokens(response: Response): Tokens<C>

- Defined in auth-toolbox.ts:377
Read tokens from received Response.

Parameters
- response: Response
  
  received response
Returns Tokens<C>

refreshTokenHasExpired

refreshTokenHasExpired(request: Request, response: Response): boolean

- Defined in auth-toolbox.ts:393
Check if refresh token has expired from Response.

Parameters
- request: Request
  
  initial request that leads to the received response
- response: Response
  
  received response
Returns boolean

setAccessToken

setAccessToken(request: Request, accessToken: string | undefined): void

- Defined in auth-toolbox.ts:370
Apply the access token to a Request.

It should add Authorization header.

Parameters
- request: Request
  
  request to configure
- accessToken: string | undefined
  
  access Token.value to apply.
Returns void

Generated using TypeDoc