Skip to main content
The MfaWebAuthnChangeKeyNickname class implements the mfa-webauthn-change-key-nickname screen functionality.
MfaWebAuthnChangeKeyNickname

​
Constructors

Create an instance of MfaWebAuthnChangeKeyNickname screen
Example
import MfaWebAuthnChangeKeyNickname from "@auth0/auth0-acul-js/mfa-webauthn-change-key-nickname";

const mfaWebAuthnChangeKeyNicknameManager = new MfaWebAuthnChangeKeyNickname();

​
Properties

​
branding
Provides branding-related configurations, such as branding theme and settings.
​
client
Provides client-related configurations, such as id, name, and logoUrl.
​
organization
Provides information about the user’s organization, such as organization id and name.
​
prompt
Contains data about the current prompt in the authentication flow.
​
screen
Contains details specific to the mfa-webauthn-change-key-nickname screen, including its configuration and context.
​
tenant
Contains data related to the tenant, such as id and associated metadata.
​
transaction
Provides transaction-specific data, such as active identifiers and flow states.
​
untrustedData
Handles untrusted data passed to the SDK, such as user input during login.
​
user
Details of the active user, including username, email, and roles.

​
Methods

​
continueWithNewNickname
(options ?)
This method submits the new nickname provided by the user for their WebAuthn security key. This method prepares and posts the form data, including the new nickname and the required action: "default", to the /u/mfa-webauthn-change-key-nickname endpoint. Returns a promise that resolves once the form submission is initiated. Typically, a successful submission leads to a server-side redirect. If the nickname is invalid or another error occurs, the page will re-render, and this.transaction.errors will be populated with details.
​
options
OPTIONAL
An object containing the nickname string entered by the user. It may also contain other custom parameters if needed for extensibility.
​
getErrors
This method retrieves the array of transaction errors from the context, or an empty array if none exist.