Signup

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

La classe Signup implémente la fonctionnalité de l’écran signup. Cet écran collecte l’identifiant et le mot de passe de l’utilisateur. Selon votre locataire, cet identifiant peut être un courriel, un numéro de téléphone ou un nom d’utilisateur.

​

Constructeurs

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

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.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 associés.

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnSignup

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

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 utilisateur pendant l’authentification.

user · UserMembers

Détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

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

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

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

persist? · "session"

Lorsqu’elle est définie sur 'session', la langue sélectionnée est conservée pendant toute 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 gère la soumission du formulaire Signup social. Elle est semblable à la méthode signup, mais elle est utilisée pour les Signups sociaux.

Example

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

Paramètres de la méthode

Afficher Paramètres

options

FederatedSignupPayloadOptions.

connection · string · requis

Le nom de la connexion sociale à utiliser.

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

getSignupIdentifiers · Identifier [] | null

Cette méthode renvoie la liste des identifiants activés pour le formulaire Signup, en indiquant pour chacun s’il est obligatoire ou facultatif selon la configuration de la transaction. Elle renvoie un tableau d’objets identifiant (par exemple, email, phone, username).

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const identifiers = signupManager.getSignupIdentifiers();
// [{ type: 'email', required: true }, { type: 'username', required: false }]

pickCountryCode · Promise<void>

Cette méthode redirige l’utilisateur vers la liste de sélection du code de pays, où il peut mettre à jour l’indicatif de pays de son numéro de téléphone.

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.pickCountryCode();

signup · Promise<void>

Cette méthode gère la soumission du formulaire Signup.

Example

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

Paramètres de la méthode

Afficher Paramètres

options

SignupPayloadOptions.

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

Le mot de passe de l’utilisateur.

captcha? · string

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

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

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

validatePassword · PasswordValidationResult

Cette méthode retourne un objet de type PasswordValidationResult indiquant si le mot de passe est valide et, sinon, pourquoi.

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const result = signupManager.validatePassword('P@$wOrd123!');

Paramètres de méthode

Afficher Paramètres

password · string · requis

Le mot de passe de l’utilisateur.

validateUsername · UsernameValidationResult

Cette méthode valide un nom d’utilisateur selon la politique de nom d’utilisateur actuellement définie dans le contexte de la transaction. Elle retourne un objet indiquant si le nom d’utilisateur est valide et, sinon, pourquoi.

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const result = signupManager.validateUsername('myusername');
// result => { valid: true, errors: [] }

Paramètres de méthode

Afficher Paramètres

username · string · requis

La chaîne de caractères du nom d’utilisateur à valider.