Interface FidoClient

Reusable client for FIDO operations.

interface FidoClient {
    authenticate(
        options: FidoAuthenticationOptions,
    ): Promise<FidoAuthenticationResult>;
    authenticateForJourney(
        journey: JourneyInstance,
        options?: FidoJourneyAuthenticationOptions,
    ): Promise<FidoJourneyResult>;
    register(options: FidoRegistrationOptions): Promise<FidoRegistrationResult>;
    registerForJourney(
        journey: JourneyInstance,
        options?: FidoJourneyRegistrationOptions,
    ): Promise<FidoJourneyResult>;
}

Index

Methods

authenticate authenticateForJourney register registerForJourney

Methods

authenticate

authenticate(
options: FidoAuthenticationOptions,
): Promise<FidoAuthenticationResult>
Authenticates with an existing FIDO credential using native platform APIs.
Parameters
- options: FidoAuthenticationOptions
  Authentication options payload.
Returns Promise<FidoAuthenticationResult>
A promise that resolves to the authentication result payload.

Throws
FidoError when native authentication fails.
- Defined in packages/fido/src/types/fido.types.ts:152

authenticateForJourney

authenticateForJourney(
journey: JourneyInstance,
options?: FidoJourneyAuthenticationOptions,
): Promise<FidoJourneyResult>
Executes an active Journey FIDO authentication callback.
Parameters
- journey: JourneyInstance
  Active Journey instance.
- Optionaloptions: FidoJourneyAuthenticationOptions
  Optional authentication callback execution options.
Returns Promise<FidoJourneyResult>
A promise that resolves when callback execution succeeds.

Throws
FidoError when native callback execution fails.
- Defined in packages/fido/src/types/fido.types.ts:175

register

register(options: FidoRegistrationOptions): Promise<FidoRegistrationResult>
Registers a new FIDO credential using native platform APIs.
Parameters
- options: FidoRegistrationOptions
  Registration options payload.
Returns Promise<FidoRegistrationResult>
A promise that resolves to the registration result payload.

Throws
FidoError when native registration fails.
- Defined in packages/fido/src/types/fido.types.ts:144

registerForJourney

registerForJourney(
journey: JourneyInstance,
options?: FidoJourneyRegistrationOptions,
): Promise<FidoJourneyResult>
Executes an active Journey FIDO registration callback.
Parameters
- journey: JourneyInstance
  Active Journey instance.
- Optionaloptions: FidoJourneyRegistrationOptions
  Optional registration callback execution options.
Returns Promise<FidoJourneyResult>
A promise that resolves when callback execution succeeds.

Throws
FidoError when native callback execution fails.
- Defined in packages/fido/src/types/fido.types.ts:163