DeviceCodeConfirmation

Décrit toutes les propriétés et méthodes offertes pour personnaliser l’écran device-code-confirmation de Universal Login.

La classe DeviceCodeConfirmation implémente les fonctionnalités de l’écran device-code-confirmation. Cet écran s’affiche lorsque l’utilisateur doit confirmer ou annuler l’activation du code d’appareil.

​

Constructeurs

Créez une instance du gestionnaire de l’écran DeviceCodeConfirmation :

Example

import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation';
const deviceCodeConfirmationManager = new DeviceCodeConfirmation();
await deviceCodeConfirmationManager.confirm();

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit les configurations liées à l’application, comme id, name et logoUrl, pour l’écran device-code-confirmation.

organization · OrganizationMembers

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

prompt · PromptMembers

Contient des données sur l’invite en cours dans le flux d’authentification.

screen · ScreenMembersOnDeviceCodeConfirmation

Contient les détails propres à l’écran device-code-confirmation, y compris sa configuration et son contexte.

tenant · TenantMembers

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

transaction · TransactionMembers

Fournit des données propres à la transaction pour l’écran device-code-confirmation, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme la saisie de l’utilisateur pendant le flux de confirmation du code d’appareil.

user · UserMembers

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

​

Méthodes

cancel · Promise<void>

Cette méthode annule le flux d’activation du code d’appareil.

Example

import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation';
const deviceCodeConfirmationManager = new DeviceCodeConfirmation();
await deviceCodeConfirmationManager.cancel();

changeLanguage · Promise<void>

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

Example

import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation';
const deviceCodeConfirmationManager = new DeviceCodeConfirmation();
deviceCodeConfirmationManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue correspondant aux paramètres régionaux souhaités (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsque cette valeur est définie sur 'session', la langue sélectionnée est conservée pendant toute la session.

confirm · Promise<void>

Cette méthode confirme le code d’appareil et poursuit l’activation.

Example

import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation';
const deviceCodeConfirmationManager = new DeviceCodeConfirmation();
await deviceCodeConfirmationManager.confirm();

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.