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 le mot de passe à usage unique envoyé à son numéro de téléphone pour terminer l’authentification SMS Passwordless.

​

Importation

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

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation depuis la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez qu’une build unifiée prenne en charge 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>
  );
}

​

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 login-passwordless-sms-otp. Importez-les depuis @auth0/auth0-acul-react/login-passwordless-sms-otp.

useBranding · () => BrandingMembers

Ce hook fournit les paramètres d’image de marque, comme le logo, les couleurs et les réglages 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 la configuration liée à l’application, 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’Organisation de l’utilisateur si la connexion est limitée à une Organisation. Retourne null lorsqu’aucun contexte d’Organisation 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 l’invite en cours 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 locataire, 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 des 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 renseignements sur l’utilisateur actif, notamment username, email et les méthodes d’authentification disponibles.

Exemple

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 dans l’écran login-passwordless-sms-otp.

​

Méthodes

resendOTP · Promise<void>

Cette méthode renvoie le mot de passe à 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()}>
      Renvoyer le 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écédés du préfixe ulp- (par exemple, 'ulp-custom-field').

submitOTP · Promise<void>

Cette méthode envoie le mot de passe à usage unique afin de terminer l’authentification SMS Passwordless.

Example

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

function SmsOtpForm() {
  const { submitOTP } = useLoginPasswordlessSmsOtp();
  return (
    <button onClick={() => submitOTP({ code: '123456' })}>
      Vérifier le code
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SubmitOTPOptions.

code · string · requis

Le mot de passe à 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 du captcha requise lorsque la détection des robots est activée sur le locataire.

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

Champs personnalisés supplémentaires précédés du préfixe ulp- (par exemple, 'ulp-custom-field').

switchConnection · Promise<void>

Cette méthode passe à 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' })}>
      Utiliser le SSO
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SwitchConnectionOptionsSmsOtp.

connection · string · requis

Le nom de la connexion vers laquelle basculer. Utilisez ‘email’ ou ‘sms’ pour Passwordless, 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écédés du préfixe ulp- (par exemple, 'ulp-custom-field').

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de modifier la langue d’affichage de 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, de l’application et du développeur à l’écran.

useResend · Hooks

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