Interface MfaWebAuthnErrorMembers

MfaWebAuthnErrorMembers

interface MfaWebAuthnErrorMembers {
    branding: Classes.BrandingMembers;
    client: Classes.ClientMembers;
    organization: Classes.OrganizationMembers;
    prompt: Classes.PromptMembers;
    screen: Classes.ScreenMembers;
    tenant: Classes.TenantMembers;
    transaction: Classes.TransactionMembers;
    untrustedData: Classes.UntrustedDataMembers;
    user: Classes.UserMembers;
    noThanks(payload?: Classes.CustomOptions): Promise<void>;
    tryAgain(payload?: Classes.CustomOptions): Promise<void>;
    tryAnotherMethod(payload?: Classes.CustomOptions): Promise<void>;
    usePassword(payload?: Classes.CustomOptions): Promise<void>;
}

Hierarchy

BaseMembers
- MfaWebAuthnErrorMembers

Implemented by

MfaWebAuthnError

Index

Properties

branding client organization prompt screen tenant transaction untrustedData user

Methods

noThanks tryAgain tryAnotherMethod usePassword

Properties

branding

branding: Classes.BrandingMembers

client

client: Classes.ClientMembers

organization

organization: Classes.OrganizationMembers

prompt

prompt: Classes.PromptMembers

screen

screen: Classes.ScreenMembers

tenant

tenant: Classes.TenantMembers

transaction

transaction: Classes.TransactionMembers

untrustedData

untrustedData: Classes.UntrustedDataMembers

user

user: Classes.UserMembers

Methods

noThanks

noThanks(payload?: Classes.CustomOptions): Promise<void>
Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. This action is typically used in enrollment scenarios where the user decides not to proceed.
Parameters
- Optionalpayload: Classes.CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
A promise that resolves when the action is successfully submitted.
Throws
Throws an error if the submission fails.
Example
```
// Assuming 'sdk' is an instance of MfaWebAuthnError
await sdk.noThanks();
```
- Defined in interfaces/screens/mfa-webauthn-error.ts:105

tryAgain

tryAgain(payload?: Classes.CustomOptions): Promise<void>
Allows the user to attempt the previous WebAuthn operation again. This typically redirects the user back to the screen where the WebAuthn operation was initiated.
Parameters
- Optionalpayload: Classes.CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
A promise that resolves when the action is successfully submitted.
Throws
Throws an error if the submission fails.
Example
```
// Assuming 'sdk' is an instance of MfaWebAuthnError
await sdk.tryAgain();
```
- Defined in interfaces/screens/mfa-webauthn-error.ts:60

tryAnotherMethod

tryAnotherMethod(payload?: Classes.CustomOptions): Promise<void>
Allows the user to select a different MFA method if other factors are enrolled or available. This navigates the user to an authenticator selection screen.
Parameters
- Optionalpayload: Classes.CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
A promise that resolves when the action is successfully submitted.
Throws
Throws an error if the submission fails.
Example
```
// Assuming 'sdk' is an instance of MfaWebAuthnError
await sdk.tryAnotherMethod();
```
- Defined in interfaces/screens/mfa-webauthn-error.ts:90

usePassword

usePassword(payload?: Classes.CustomOptions): Promise<void>
Allows the user to opt for password-based authentication as an alternative, if configured. This is typically available if the primary authentication or a previous step involved a password.
Parameters
- Optionalpayload: Classes.CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
A promise that resolves when the action is successfully submitted.
Throws
Throws an error if the submission fails.
Example
```
// Assuming 'sdk' is an instance of MfaWebAuthnError
await sdk.usePassword();
```
- Defined in interfaces/screens/mfa-webauthn-error.ts:75