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 le fonctionnement de l’écran signup-password. Cet écran permet à l’utilisateur de saisir son mot de passe.

​

Constructeurs

Créez une instance du gestionnaire d’é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 d’image de marque et les paramètres.

client · ClientMembers

Fournit des configurations liées au client, 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 le prompt actuel dans le flux d’authentification.

screen · ScreenMembersOnSignupPassword

Contient des renseignements propres à l’écran signup-password, 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 · 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 données saisies par l’utilisateur lors de la connexion.

user · UserMembers

Renseignements sur l’utilisateur actif, notamment le username, l’email et les 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 locale correspondant à la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

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

federatedSignup · Promise<void>

Cette méthode redirige l’utilisateur vers le Social ou le fournisseur d’identité Enterprise (IdP) pour l’inscription.

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 Social ou du fournisseur d’identité Enterprise.

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. Elle renvoie un tableau d’objets d’erreur du contexte de la transaction.

signup · Promise<void>

Cette méthode gère la soumission du formulaire d’inscription avec 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

L’adresse 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 Bot Detection est activé dans votre tenant 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 bascule la 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.

validatePassword · PasswordValidationResult

Cette méthode valide un mot de passe par rapport à la politique 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.