Skip to content

Reference

Interfaces

Enumerations

Variables

authenticate

Const authenticate: WebauthnAuthenticationFlows

Returns the authentication flows for webauthn


approve

Const approve: WebauthnApprovalFlows


crossDevice

crossDevice: WebauthnCrossDeviceFlows

Functions

register

register(username, options?): Promise<string>

Invokes a WebAuthn credential registration for the specified user, including prompting the user for biometrics. If registration is completed successfully, this call will return a promise that resolves to the credential result, which is an object encoded as a base64 string. This encoded result should then be passed to the relevant backend registration endpoint to complete the registration for either a logged-in user or logged-out user.

If registration fails, an SdkError will be thrown.

Throws

NotInitialized

Throws

RegistrationFailed

Throws

RegistrationCanceled

Parameters

NameTypeDescription
usernamestringWebAuthn username to register
options?WebauthnRegistrationOptionsAdditional configuration for registration flow

Returns

Promise<string>


isPlatformAuthenticatorSupported

isPlatformAuthenticatorSupported(): Promise<undefined | boolean>

Returns

Promise<undefined | boolean>


isAutofillSupported

isAutofillSupported(): Promise<boolean>

Returns

Promise<boolean>


getDefaultPaths

getDefaultPaths(): WebauthnApis

Returns

WebauthnApis