SignupId

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

La classe SignupId implémente les fonctionnalités de l’écran signup-id. Cet écran recueille l’identifiant de l’utilisateur — comme son courriel, son nom d’utilisateur ou son numéro de téléphone — à la première étape d’un flux d’inscription en plusieurs étapes. Il prend également en charge l’inscription fédérée au moyen de connexions sociales ou d’entreprise et de Google One Tap.

​

Constructeurs

Créez une instance du gestionnaire d’écran SignupId :

Example

import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.signup({
  email: '[e-mail]',
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran signup-id.

organization · OrganizationMembers

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

prompt · PromptMembers

Contient des données sur le prompt actuel dans le flux d’authentification.

screen · ScreenMembersOnSignupId

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

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 lors du login.

user · UserMembers

Contient les 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 SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.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 à 'session', la langue sélectionnée est conservée pendant toute la session.

federatedSignup · Promise<void>

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

Example

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

Paramètres de la méthode

Afficher Paramètres

options

FederatedSignupOptions.

connection · string · requis

Le nom de la connexion du fournisseur d’identité Social ou entreprise.

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 pas. Elle renvoie 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 signup-id, en indiquant pour chacun s’il est obligatoire ou facultatif selon la configuration de la transaction. Un tableau d’objets d’identifiant (par exemple : email, phone, username).

Example

import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
const identifiers = signupIdManager.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 une 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 SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.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 de l’indicatif de pays, où il peut mettre à jour l’indicatif de pays de son numéro de téléphone.

Example

import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.pickCountryCode();

signup · Promise<void>

Cette méthode gère la configuration associée à signup-id. Elle permet à de nouveaux utilisateurs de s’inscrire au moyen de différents identifiants.

Example

import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.signup({
  email: '[e-mail]',
});

Paramètres de la méthode

Afficher Paramètres

options

SignupOptions.

email? · string

L’adresse courriel.

username? · string

L’identifiant de l’utilisateur.

phone? · string

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

captcha? · string

Le code captcha ou la réponse du fournisseur CAPTCHA. Cette propriété est requise si votre tenant Auth0 a Bot Detection activé.

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

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

validateUsername · UsernameValidationResult

Cette méthode valide un nom d’utilisateur donné en fonction de la politique de nom d’utilisateur définie dans le contexte de la transaction. Elle renvoie un objet indiquant si le nom d’utilisateur est valide et pourquoi.

Example

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

Paramètres de la méthode

Afficher Paramètres

username · string · requis

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