LoginEmailVerification

L’écran login-email-verification invite l’utilisateur à saisir un code de vérification envoyé à son adresse de courriel afin de confirmer son identité pendant le flux de connexion.

Vérification du courriel lors de la connexion

Import

Chaque écran a son propre ensemble de Hooks et de méthodes. Le SDK prend en charge les imports partiels et les imports à la racine pour chaque écran.

Un import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
Un import à la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une même build prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useLoginEmailVerification,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  useResend,
  // Méthodes
  continueWithCode,
  resendCode,
} from '@auth0/auth0-acul-react/login-email-verification';

function LoginEmailVerificationForm() {
  const { continueWithCode } = useLoginEmailVerification();
  return (
    <button onClick={() => continueWithCode({ code: '123456' })}>
      Verify
    </button>
  );
}

Hooks de contexte

Hooks propres à l’écran qui fournissent un accès en lecture seule aux données de contexte Auth0 sur l’écran login-email-verification. Importez-les à partir de @auth0/auth0-acul-react/login-email-verification.

useBranding

() => BrandingMembers

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

Example

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

useClient

() => ClientMembers

Ce hook fournit les configurations liées à l’application, comme id, name et logoUrl, pour l’écran login-email-verification.

Example

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

useOrganization

() => OrganizationMembers

Ce hook fournit des renseignements sur l’organisation de l’utilisateur si la connexion est limitée à une organisation. Renvoie null lorsqu’aucun contexte d’organisation n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/login-email-verification';
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/login-email-verification';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen

() => ScreenMembers

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

Example

import { useScreen } from '@auth0/auth0-acul-react/login-email-verification';
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/login-email-verification';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction

() => TransactionMembers

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

Example

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

useUntrustedData

() => UntrustedDataMembers

Ce hook expose les données non fiables transmises à l’écran, comme les paramètres des chaînes de requête d’URL.

Example

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

useUser

() => UserMembers

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

Example

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

Ce hook renvoie toutes les méthodes et tout le contexte disponibles sur l’écran login-email-verification.

Méthodes

continueWithCode

Promise<void>

Cette méthode envoie le code de vérification saisi par l’utilisateur pour poursuivre la vérification de l’adresse courriel.

Example

import { useLoginEmailVerification } from '@auth0/auth0-acul-react/login-email-verification';

function VerifyEmail() {
  const { continueWithCode } = useLoginEmailVerification();
  return (
    <button onClick={() => continueWithCode({ code: '123456' })}>
      Verify
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ContinueWithCodeOptionPayload.

code

string

requis

Le code de vérification envoyé à l’adresse courriel de l’utilisateur.

[`key`: `string`]

"string" | "number" | "boolean" | "undefined"

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

resendCode

Promise<void>

Cette méthode demande l’envoi d’un nouveau code de vérification à l’adresse courriel de l’utilisateur.

Example

import { useLoginEmailVerification } from '@auth0/auth0-acul-react/login-email-verification';

function ResendCode() {
  const { resendCode } = useLoginEmailVerification();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}