SignupPassword

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

L’écran signup-password recueille le mot de passe de l’utilisateur pour terminer la création du compte. Il s’agit de la deuxième étape d’un flux d’inscription en plusieurs étapes, après la collecte de l’identifiant. Il prend aussi en charge l’inscription fédérée au moyen de connexions sociales ou d’entreprise.

​

Importation

Chaque écran possède son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’importation partielle et l’importation racine pour chaque écran.

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez une compilation unifiée capable de gérer tous les écrans possibles.

Import Example

// importation racine
import { useSignupPassword } from '@auth0/auth0-acul-react';

// importation partielle
import {
  useSignupPassword,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  usePasswordValidation,
  // Méthodes
  signup,
  federatedSignup,
  switchConnection,
} from '@auth0/auth0-acul-react/signup-password';

function SignupPasswordForm() {
  const { signup } = useSignupPassword();
  return (
    <button onClick={() => signup({ password: 'secret' })}>
      Create Account
    </button>
  );
}

​

Hooks de contexte

Des hooks propres à l’écran qui fournissent un accès en lecture seule aux données de contexte Auth0 sur l’écran signup-password. Importez-les depuis @auth0/auth0-acul-react/signup-password.

useBranding · () => BrandingMembers

Ce hook fournit les configurations d’image de marque, comme le logo, les couleurs et les paramètres du thème affichés sur l’écran signup-password.

Example

import { useBranding } from '@auth0/auth0-acul-react/signup-password';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

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

Example

import { useClient } from '@auth0/auth0-acul-react/signup-password';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

Ce hook fournit de l’information sur l’organisation de l’utilisateur si l’inscription est limitée à une organisation. Il renvoie null lorsqu’aucun contexte d’organisation n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/signup-password';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

Ce hook contient des données sur le prompt actuel dans le flux d’authentification.

Example

import { usePrompt } from '@auth0/auth0-acul-react/signup-password';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnSignupPassword

Ce hook contient des détails propres à l’écran signup-password, y compris sa configuration et son contexte.

Example

import { useScreen } from '@auth0/auth0-acul-react/signup-password';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

Ce hook contient des données liées au tenant, comme id et les métadonnées associées.

Example

import { useTenant } from '@auth0/auth0-acul-react/signup-password';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembersOnSignupPassword

Ce hook fournit des données propres à la transaction pour l’écran signup-password, comme les connexions actives et l’état actuel du flux.

Example

import { useTransaction } from '@auth0/auth0-acul-react/signup-password';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme une adresse courriel ou un nom d’utilisateur prérempli à partir de paramètres d’URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/signup-password';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Ce hook fournit des détails sur l’utilisateur actif, notamment le username, l’email et les méthodes d’authentification disponibles.

Example

import { useUser } from '@auth0/auth0-acul-react/signup-password';
function UserProfile() {
  const user = useUser();
}

useSignupPassword · SignupPasswordMembers

Ce hook renvoie toutes les méthodes et tout le contexte disponibles sur l’écran signup-password.

​

Méthodes

federatedSignup · Promise<void>

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

Example

import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';

function SocialButton() {
  const { federatedSignup } = useSignupPassword();
  return (
    <button onClick={() => federatedSignup({ connection: 'google-oauth2' })}>
      Sign up with Google
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

FederatedSignupPasswordPayloadOptions.

connection · string · requis

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

signup · Promise<void>

Cette méthode soumet le mot de passe de l’utilisateur pour terminer la création du compte.

Example

import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';

function SignupPasswordForm() {
  const { signup } = useSignupPassword();
  return (
    <button onClick={() => signup({ password: 'secret' })}>
      Create Account
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SignupPasswordOptions.

password · string · requis

Le mot de passe du nouveau compte.

email · string

L’adresse courriel de l’utilisateur.

username · string

Le nom d’utilisateur du nouveau compte, si la connexion l’exige.

phoneNumber · string

Le numéro de téléphone de l’utilisateur, si la connexion l’exige.

captcha? · string

Valeur captcha requise lorsque Bot Detection est activé sur le tenant.

[`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 change la connexion active pendant l’étape signup-password, ce qui permet à l’utilisateur de s’authentifier au moyen d’une autre connexion.

Example

import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';

function SwitchConnection() {
  const { switchConnection } = useSignupPassword();
  return (
    <button onClick={() => switchConnection({ connection: 'Username-Password-Authentication' })}>
      Use a different method
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SwitchConnectionOptionsSignupPassword.

connection · string · requis

Le nom de la connexion vers laquelle basculer. Utilisez email ou sms pour l’authentification sans mot de passe, ou un nom de connexion de base de données pour l’authentification par mot de passe.

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

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

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration à plat à partir du contexte d’image de marque.

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de changer la langue d’affichage sur l’écran ACUL actuel.

useCurrentScreen · Hooks

Ce hook récupère le contexte et l’état de l’écran actuel.

useErrors · Hooks

Ce hook permet de lire et de gérer les erreurs du serveur, du client et du développeur à l’écran.

usePasswordValidation · Hooks

Ce hook valide le mot de passe de l’utilisateur en fonction des exigences de la politique de mot de passe du tenant.