SignupId

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

L’écran signup-id permet de saisir l’identifiant de l’utilisateur — par exemple, un courriel, un nom d’utilisateur ou un numéro de téléphone — comme 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.

​

Importation

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

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’usage.
• L’importation à la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez qu’un build unifié prenne en charge tous les écrans possibles.

Import Example

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

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

function SignupIdForm() {
  const { signup } = useSignupId();
  return (
    <button onClick={() => signup({ email: '[e-mail]' })}>
      Continue
    </button>
  );
}

​

Hooks de contexte

Hooks associés à l’écran qui fournissent un accès en lecture seule aux données de contexte Auth0 pour l’écran signup-id. Importez-les depuis @auth0/auth0-acul-react/signup-id.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

Ce hook fournit la configuration liée à l’application, comme id, name et logoUrl, pour l’écran signup-id.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organisation de l’utilisateur si l’inscription est associée à une Organisation. Renvoie null lorsqu’aucun contexte d’Organisation n’est présent.

Example

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

usePrompt · () => PromptMembers

Ce hook contient des données sur l’invite en cours dans le flux d’authentification.

Example

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

useScreen · () => ScreenMembersOnSignupId

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnSignupId

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useSignupId · SignupIdMembers

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

​

Méthodes

federatedSignup · Promise<void>

Cette méthode lance l’inscription au moyen d’un fournisseur d’identité fédéré, comme Google ou GitHub.

Example

import { useSignupId } from '@auth0/auth0-acul-react/signup-id';

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

Paramètres de la méthode

Afficher Paramètres

options

FederatedSignupOptions.

connection · string · requis

Le nom de la connexion sociale ou d’entreprise à utiliser (p. ex. google-oauth2, github).

pickCountryCode · Promise<void>

Cette méthode ouvre le sélecteur de code de pays pour saisir le numéro de téléphone lors de l’inscription.

Example

import { useSignupId } from '@auth0/auth0-acul-react/signup-id';

function CountryCodePicker() {
  const { pickCountryCode } = useSignupId();
  return (
    <button onClick={() => pickCountryCode()}>
      Select Country Code
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

CustomOptions.

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

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

signup · Promise<void>

Cette méthode envoie l’identifiant de l’utilisateur pour passer à l’étape suivante du flux d’inscription.

Example

import { useSignupId } from '@auth0/auth0-acul-react/signup-id';

function SignupIdForm() {
  const { signup } = useSignupId();
  return (
    <button onClick={() => signup({ email: '[e-mail]' })}>
      Continue
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SignupOptions.

email · string

L’adresse courriel de l’utilisateur.

username · string

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

phone · string

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

captcha? · string

Valeur du captcha requise lorsque la fonctionnalité de détection de bot est activée sur le locataire.

[`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 qui permet 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 lit et gère les erreurs serveur, client et développeur à l’écran.

useSignupIdentifiers · Hooks

Ce hook renvoie les types d’identifiants d’inscription disponibles (courriel, nom d’utilisateur, téléphone) configurés pour la connexion.

useUsernameValidation · Hooks

Ce hook valide le nom d’utilisateur selon les exigences de la stratégie relative aux noms d’utilisateur du locataire.