LoginPasswordlessEmailCode

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran login-passwordless-email-code d’Universal Login.

L’écran login-passwordless-email-code invite l’utilisateur à saisir un code à usage unique envoyé à son adresse courriel afin de terminer l’authentification sans mot de passe.

​

Importation

Chaque écran comporte 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’utilisation de l’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’utilisation de l’importation à la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez une version unifiée capable de gérer tous les écrans possibles.

Import Example

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

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

function EmailCodeForm() {
  const { submitCode } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

Ce hook fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran login-passwordless-email-code.

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

import { usePrompt } from '@auth0/auth0-acul-react/login-passwordless-email-code';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnLoginPasswordlessEmailCode

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

Example

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

useTransaction · () => TransactionMembersOnLoginPasswordlessEmailCode

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useLoginPasswordlessEmailCode · LoginPasswordlessEmailCodeMembers

Ce hook renvoie toutes les méthodes et le contexte disponibles dans l’écran login-passwordless-email-code.

​

Méthodes

resendCode · Promise<void>

Cette méthode renvoie le code à usage unique à l’adresse courriel de l’utilisateur.

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

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

submitCode · Promise<void>

Cette méthode envoie le code à usage unique pour terminer l’authentification sans mot de passe par courriel.

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

function EmailCodeForm() {
  const { submitCode } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>
      Verify Code
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SubmitCodeOptions.

code · string | number · requis

Le code à usage unique envoyé à l’adresse courriel de l’utilisateur.

captcha? · string

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

switchConnection · Promise<void>

Cette méthode bascule vers une autre connexion d’authentification sans redémarrer le flux.

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

function ConnectionSwitcher() {
  const { switchConnection } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => switchConnection({ connection: 'enterprise-saml' })}>
      Use SSO
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SwitchConnectionOptionsEmailCode.

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.

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration aplatie issue 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 lit et gère les erreurs du serveur, du client et du développeur sur l’écran.

useResend · Hooks

Ce hook gère le délai d’attente et la disponibilité des actions de renvoi de code.