Interface AuthenticationProvider

Authentication provider interface (used to authenticate requests)

interface AuthenticationProvider {
authenticate(request: Request): Promise<void>;
authenticationFailed(request: Request, reason: Response): Promise<void>;
}

Index

Methods

authenticate authenticationFailed

Methods

authenticate

authenticate(request: Request): Promise<void>
Authenticates the request (e.g. adds authentication headers) request: The request to authenticate Note: This method should reject the promise if the request cannot be authenticated.
Parameters
- request: Request
Returns Promise<void>
- Defined in Request.ts:28

authenticationFailed

authenticationFailed(request: Request, reason: Response): Promise<void>
Called when the request fails with a 401 Unauthorized response request: The request that failed reason: The reason for the failure
Parameters
- request: Request
- reason: Response
Returns Promise<void>
- Defined in Request.ts:33