Class PasskeyAuth

The AuthModule implementing Passkey authentication.

Implements

AuthModule

Index

Constructors

Methods

Constructors

constructor

new PasskeyAuth(
rpConfig: RelyingPartyConfig,
allowCredentialId: string,
): PasskeyAuth
Parameters
- rpConfig: RelyingPartyConfig
  Passkey relying party configuration. Read more: https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredentialCreationOptions#rp
- allowCredentialId: string
  ID of the acceptable credential by user. App proves that user has passkey credential by passing the value of this field
Returns PasskeyAuth
- Defined in auth/authentication.ts:188

Methods

authenticate

authenticate(
payload: AuthModuleParams<PasskeyLoginPayload>,
): Promise<UserAuthentication>
Prepares a message for Passkey login flow and prompts user device's authenticator to sign it.
Parameters
- payload: AuthModuleParams<PasskeyLoginPayload>
  request payload to be sent to the backend
Returns Promise<UserAuthentication>
Implementation of AuthModule.authenticate
- Defined in auth/authentication.ts:199