Inscription

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

La classe Signup implémente la fonctionnalité de l’écran signup. Cet écran recueille les identifiants de l’utilisateur pour créer un nouveau compte. Selon votre tenant, l’identifiant peut être une adresse courriel, un numéro de téléphone ou un nom d’utilisateur. Il prend également en charge l’inscription fédérée par l’intermédiaire de connexions Social ou Enterprise et de Google One Tap.

​

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 de l’image de marque.

client · ClientMembers

Fournit des configurations liées au client, 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 le prompt actuel 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 tenant, 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 de l’utilisateur pendant la connexion.

user · UserMembers

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 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 paramètre régional de la langue souhaitée (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 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 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 Social ou du fournisseur d’identité Enterprise.

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. Un tableau d’objets d’erreur provenant du contexte de transaction.

getSignupIdentifiers · Identifier [] | null

Cette méthode renvoie la liste des identifiants activés pour le formulaire d’inscription, en indiquant pour chacun s’il est obligatoire ou facultatif selon la configuration de la transaction. Un tableau d’objets d’identifiant (par exemple, courriel, téléphone, nom d’utilisateur).

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 }]

googleOneTap · Promise<void>

Cette méthode inscrit un nouvel utilisateur à l’aide d’un identifiant Google One Tap, ce qui permet l’inscription en un clic sans redirection vers une page distincte.

Vérifiez screen.googleOneTapConfig avant d’afficher l’invite Google One Tap — sa valeur est null lorsque la fonctionnalité n’est pas activée côté serveur.

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.googleOneTap({ one_tap_credential: credential });

Paramètres de la méthode

Afficher Paramètres

one_tap_credential · string · requis

Le jeton d’identifiant Google One Tap renvoyé par l’invite Google Identity Services.

pickCountryCode · Promise<void>

Cette méthode redirige l’utilisateur vers la liste de sélection des indicatifs 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 traite la soumission du formulaire d’inscription.

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

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

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ée 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').

validatePassword · PasswordValidationResult

Cette méthode renvoie un objet de type PasswordValidationResult indiquant si le mot de passe est valide et la raison.

Example

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

Paramètres de la 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 actuelle sur les noms d’utilisateur définie dans le contexte de la transaction. Elle renvoie un objet indiquant si le nom d’utilisateur est valide et la raison.

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 la méthode

Afficher Paramètres

username · string · requis

Le nom d’utilisateur à valider.