Interface ServerAuthenticator<Credential, Data, Context>

Type parameters

Credential
Data
Context: AnyAuthContext

Hierarchy

ServerAuthenticator

Implemented by

Index

Properties

platform

Methods

Properties

platform

platform: string

Methods

checkAuthData

checkAuthData(data: Data): CheckDataResult<Context>

- Defined in packages/auth/src/types.ts:113
Called before the authorization finish, you can make some simple non-async final checks. Return the auth context supplement if success.

Parameters
- data: Data
Returns CheckDataResult<Context>

delegateAuthRequest

delegateAuthRequest(req: IncomingMessage, res: ServerResponse, routingInfo: Required<RoutingInfo>): Promise<void>

- Defined in packages/auth/src/types.ts:90
Handle requests required in the auth flow, for the most of time, it's used for redirecting user-agent from/to other identity provider (IdP). Any request match route "/{platform}/*" would be delegated to this method, and it's responsible to close the the server response.

Parameters
- req: IncomingMessage
- res: ServerResponse
- routingInfo: Required<RoutingInfo>
Returns Promise<void>

verifyCredential

verifyCredential(credential: Credential): Promise<VerifyResult<Data>>

- Defined in packages/auth/src/types.ts:101
Called when sign requests from client side are received, controller would sign in the user by issuing a token to client and signing a signature wihtin cookie if it resolve success.

Parameters
- credential: Credential
Returns Promise<VerifyResult<Data>>

verifyRefreshment

verifyRefreshment(data: Data): Promise<VerifyResult<Data>>

- Defined in packages/auth/src/types.ts:107
Called when refresh requests from client side are received, controller would refresh token and signature if it resolve success.

Parameters
- data: Data
Returns Promise<VerifyResult<Data>>

Generated using TypeDoc