Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0.com/llms.txt

Use this file to discover all available pages before exploring further.

The MfaWebAuthnPlatformEnrollment class implements the mfa-webauthn-platform-enrollment screen functionality. This screen is displayed when the user needs to enroll a platform authenticator, such as Touch ID or Face ID.
MfaWebAuthnPlatformEnrollment

​
Constructors

Create an instance of MFA WebAuthn Platform Enrollment screen manager:
Example
import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.submitPasskeyCredential();

​
Properties

​
branding
BrandingMembers
Provides branding-related configurations, such as branding theme and settings.
​
client
ClientMembers
Provides client-related configurations, such as id, name, and logoUrl, for the mfa-webauthn-platform-enrollment screen.
​
organization
OrganizationMembers
Provides information about the user’s Organization, such as id and name.
​
prompt
PromptMembers
Contains data about the current prompt in the authentication flow.
​
screen
ScreenMembersOnMfaWebAuthnPlatformEnrollment
Contains details specific to the mfa-webauthn-platform-enrollment screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembers
Provides transaction-specific data for the mfa-webauthn-platform-enrollment screen, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembers
Handles untrusted data passed to the SDK, such as user input during MFA WebAuthn platform enrollment.
​
user
UserMembers
Details of the active user, including username, email, and roles.

​
Methods

​
changeLanguage
Promise<void>
This method changes the display language of the Universal Login page.
Example
import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
mfaWebAuthnPlatformEnrollment.changeLanguage({
  language: 'fr',
});
Method Parameters
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
​
refuseEnrollmentOnThisDevice
Promise<void>
This method allows the user to refuse WebAuthn platform enrollment on the current device.
Example
import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.refuseEnrollmentOnThisDevice();
Method Parameters
​
reportBrowserError
Promise<void>
This method reports a browser-side error encountered during the WebAuthn navigator.credentials.create() operation.
Example
import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.reportBrowserError({
  error: { name: 'NotAllowedError', message: 'The operation was not allowed.' },
});
Method Parameters
​
snoozeEnrollment
Promise<void>
This method allows the user to postpone WebAuthn platform enrollment.
Example
import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.snoozeEnrollment();
Method Parameters
​
submitPasskeyCredential
Promise<void>
This method initiates the WebAuthn platform credential creation and submits the resulting credential to the server.
Example
import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.submitPasskeyCredential();
Method Parameters