MfaWebAuthnChangeKeyNickname

Example

import MfaWebAuthnChangeKeyNickname from "@auth0/auth0-acul-js/mfa-webauthn-change-key-nickname";

const mfaWebAuthnChangeKeyNicknameManager = new MfaWebAuthnChangeKeyNickname();

Constructors

MfaWebAuthnChangeKeyNickname · Constructor

Initializes a new instance of the MfaWebAuthnChangeKeyNickname class. It retrieves the necessary context (screen, transaction, etc.) from the global universal_login_context and sets up screen-specific properties via ScreenOverride.

Throws

If the Universal Login Context is not available or if the screen name in the context does not match MfaWebAuthnChangeKeyNickname.screenIdentifier.

Properties

branding

client

organization

prompt

screen

Holds the specific screen data and properties for this screen, processed by ScreenOverride. This includes the current nickname of the key.

tenant

transaction

untrustedData

user

screenIdentifier · string

Methods

continueWithNewNickname · Promise<void>

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.

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.

Throws

If payload.nickname is missing or not a string. It can also throw if FormHandler encounters an unrecoverable issue during submission (e.g., network error). Auth0 validation errors (e.g., “nickname-too-long”) are not thrown as JS errors but are made available in this.transaction.errors post-operation.

Show Parameters

payload

Properties

nickname · string

getErrors

Retrieves the array of transaction errors from the context, or an empty array if none exist.

An array of error objects from the transaction context.