MfaWebAuthnChangeKeyNickname

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran mfa-webauthn-change-key-nickname d’Universal Login.

La classe MfaWebAuthnChangeKeyNickname implémente la fonctionnalité de l’écran mfa-webauthn-change-key-nickname. Cet écran s’affiche lorsque l’utilisateur doit modifier le surnom de sa clé de sécurité WebAuthn.

​

Constructeurs

Créez une instance du gestionnaire de l’écran MFA WebAuthn de modification du surnom de la clé :

Example

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

const mfaWebAuthnChangeKeyNickname = new MfaWebAuthnChangeKeyNickname();
await mfaWebAuthnChangeKeyNickname.continueWithNewNickname({ nickname: 'My YubiKey' });

​

Propriétés

branding · BrandingMembers

Fournit des configurations liées à l’image de marque, comme le thème et les paramètres.

client · ClientMembers

Fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran mfa-webauthn-change-key-nickname.

organization · OrganizationMembers

Fournit des renseignements sur l’organisation de l’utilisateur, comme id et name.

prompt · PromptMembers

Contient des données sur l’étape actuelle du flux d’authentification.

screen · ScreenMembersOnMfaWebAuthnChangeKeyNickname

Contient des détails propres à l’écran mfa-webauthn-change-key-nickname, y compris sa configuration et son contexte.

tenant · TenantMembers

Contient des données liées au tenant, comme id et les métadonnées associées.

transaction · TransactionMembers

Fournit des données propres à la transaction pour l’écran mfa-webauthn-change-key-nickname, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme les données saisies par l’utilisateur pendant la modification du surnom de la clé WebAuthn de l’AMF.

user · UserMembers

Contient les détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode modifie la langue d’affichage de la page Universal Login.

Example

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

const mfaWebAuthnChangeKeyNickname = new MfaWebAuthnChangeKeyNickname();
mfaWebAuthnChangeKeyNickname.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Si cette valeur est définie sur 'session', la langue sélectionnée est enregistrée pendant toute la durée de la session.

continueWithNewNickname · Promise<void>

Cette méthode envoie le nouveau surnom de la clé de sécurité WebAuthn de l’utilisateur.

Example

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

const mfaWebAuthnChangeKeyNickname = new MfaWebAuthnChangeKeyNickname();
await mfaWebAuthnChangeKeyNickname.continueWithNewNickname({ nickname: 'My YubiKey' });

Paramètres de la méthode

Afficher Paramètres

options

MfaWebAuthnChangeKeyNicknameContinueOptions.

nickname · string · requis

Le nouveau surnom de la clé de sécurité WebAuthn.

getErrors · Error []

Cette méthode récupère le tableau des erreurs de transaction à partir du contexte, ou un tableau vide s’il n’y en a aucune.