SignupPassword

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran signup-password d’Universal Login.

La classe SignupPassword implémente la fonctionnalité de l’écran signup-password. Cet écran permet à l’utilisateur de saisir son mot de passe.

​

Constructeurs

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

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.signup({
  email: '[e-mail]',
  password: 'P@$wOrd123!',
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran signup-password.

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 · ScreenMembersOnSignupPassword

Contient les détails propres à l’écran signup-password, 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 · TransactionMembersOnSignupPassword

Fournit des données propres à la transaction, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme les entrées de l’utilisateur pendant la connexion.

user · UserMembers

Détails sur 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 SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.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"

Lorsqu’elle est définie à 'session', la langue sélectionnée est conservée pendant toute la durée de la session.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Champs personnalisés supplémentaires préfixés par ulp- (par exemple, 'ulp-custom-field').

federatedSignup · Promise<void>

Cette méthode permet de s’inscrire au moyen de différentes connexions sociales. Par exemple : Google, Facebook, etc.

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.federatedSignup({
  connection: 'google-oauth2',
});

Paramètres de la méthode

Afficher Paramètres

options

FederatedSignupPasswordPayloadOptions.

connection · string · requis

Le nom de la connexion sociale à utiliser.

getErrors · Error []

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

signup · Promise<void>

Cette méthode gère l’envoi du formulaire d’inscription par mot de passe.

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.signup({
  email: '[e-mail]',
  password: 'P@$wOrd123!',
});

Paramètres de la méthode

Afficher Paramètres

options

SignupPasswordOptions.

email? · string

Le courriel de l’utilisateur.

username? · string

L’identifiant de l’utilisateur.

phoneNumber? · string

Le numéro de téléphone de l’utilisateur.

password · string · requis

Le mot de passe de l’utilisateur.

captcha? · string

Le code captcha ou la réponse du fournisseur CAPTCHA. Cette propriété est requise si la détection des bots est activée pour votre locataire Auth0.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Champs personnalisés supplémentaires préfixés par ulp- (par exemple, 'ulp-custom-field').

switchConnection · Promise<void>

Cette méthode permet de changer de connexion d’authentification pendant le flux signup-password.

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.switchConnection({
  connection: 'Username-Password-Authentication',
});

Paramètres de la méthode

Afficher Paramètres

options

SwitchConnectionOptionsSignupPassword.

connection · string · requis

L’identifiant de la connexion vers laquelle basculer pendant le flux d’authentification signup-password.

[`key`: `string`] · "string" | "number" | "boolean"

Champs personnalisés supplémentaires préfixés par ulp- (par exemple, 'ulp-custom-field').

validatePassword · PasswordValidationResult

Cette méthode valide un mot de passe sous forme de chaîne selon la stratégie de mot de passe de la transaction en cours. Elle renvoie un objet indiquant si le mot de passe est valide et pour quelle raison.

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
const result = signupPasswordManager.validatePassword('MyP@ssw0rd!');

Paramètres de la méthode

Afficher Paramètres

password · string · requis

Le mot de passe à valider.