LoginPasswordlessSmsOtp

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran login-passwordless-sms-otp de Universal Login.

L’écran login-passwordless-sms-otp invite l’utilisateur à saisir un code à usage unique envoyé à son numéro de téléphone afin de terminer l’authentification SMS sans mot de passe.

​

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 à la racine pour chaque écran.

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

Import Example

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

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

function SmsOtpForm() {
  const { submitOTP } = useLoginPasswordlessSmsOtp();
  return (
    <button onClick={() => submitOTP({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

Hook de contexte

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

useBranding · () => BrandingMembers

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

Example

import { useBranding } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';
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-sms-otp.

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnLoginPasswordlessSmsOtp

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

Example

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

useTransaction · () => TransactionMembersOnLoginPasswordlessSmsOtp

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme un numéro de téléphone prérempli à partir de paramètres d’URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';
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/login-passwordless-sms-otp';
function UserProfile() {
  const user = useUser();
}

useLoginPasswordlessSmsOtp · LoginPasswordlessSmsOtpMembers

Ce hook renvoie toutes les méthodes et le contexte disponibles sur l’écran login-passwordless-sms-otp.

​

Méthodes

resendOTP · Promise<void>

Cette méthode renvoie le code à usage unique (OTP) au numéro de téléphone de l’utilisateur.

Example

import { useLoginPasswordlessSmsOtp } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';

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

submitOTP · Promise<void>

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

Example

import { useLoginPasswordlessSmsOtp } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';

function SmsOtpForm() {
  const { submitOTP } = useLoginPasswordlessSmsOtp();
  return (
    <button onClick={() => submitOTP({ code: '123456' })}>
      Verify Code
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SubmitOTPOptions.

code · string · requis

Le code à usage unique envoyé au numéro de téléphone de l’utilisateur.

username? · string

Le numéro de téléphone ou l’identifiant de l’utilisateur, si le flux l’exige.

captcha? · string

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

switchConnection · Promise<void>

Cette méthode permet de passer à une autre connexion d’authentification sans redémarrer le flux.

Example

import { useLoginPasswordlessSmsOtp } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';

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

Paramètres de la méthode

Afficher Paramètres

options

SwitchConnectionOptionsSmsOtp.

connection · string · requis

Le nom de la connexion vers laquelle passer. Utilisez ‘email’ ou ‘sms’ pour le mode 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 permet d’obtenir 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 permet d’obtenir le contexte et l’état de l’écran actuel.

useErrors · Hooks

Ce hook lit et gère les erreurs du serveur, côté client et de développement à l’écran.

useResend · Hooks

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