MfaLoginOptions

Describe todos los Hooks y métodos disponibles para personalizar la pantalla mfa-login-options en Universal Login.

La pantalla mfa-login-options muestra los factores de MFA disponibles para que el usuario elija uno durante el flujo de inicio de sesión.

​

Importación

Cada pantalla tiene su propio conjunto de hooks y métodos. El SDK admite importaciones parciales e importaciones desde la raíz para cada pantalla.

• Las importaciones parciales te permiten incluir solo el código que necesitas para tu caso de uso.
• Las importaciones desde la raíz te permiten cargar todas las pantallas desde un único paquete, lo que resulta útil cuando quieres una compilación unificada que gestione todas las pantallas posibles.

Import Example

// importación raíz
import { useMfaLoginOptions } from '@auth0/auth0-acul-react';

// importación parcial
import {
  useMfaLoginOptions,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  enroll,
  returnToPrevious,
} from "@auth0/auth0-acul-react/mfa-login-options";

function MfaLoginOptionsScreen() {
  const { enroll } = useMfaLoginOptions();
  return (
    <button onClick={() => enroll({ action: 'totp' })}>
      Use Authenticator App
    </button>
  );
}

​

Hooks de contexto

Hooks de ámbito de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla mfa-login-options. Impórtelos desde @auth0/auth0-acul-react/mfa-login-options.

useBranding · () => BrandingMembers

Este hook proporciona configuraciones de marca, como el logotipo, los colores y los ajustes del tema que se muestran en la pantalla mfa-login-options.

Example

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

useClient · () => ClientMembers

Este hook proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla mfa-login-options.

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el flujo de MFA está limitado a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

usePrompt · () => PromptMembers

Este hook contiene datos sobre la pantalla actual del flujo de autenticación.

Example

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

useScreen · () => ScreenMembersOnMfaLoginOptions

Este hook contiene detalles específicos de la pantalla mfa-login-options, incluida su configuración y contexto.

Example

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

useTenant · () => TenantMembers

Este hook contiene datos relacionados con el inquilino, como id y los metadatos asociados.

Example

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

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla mfa-login-options, como el estado actual del flujo de MFA.

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook expone los datos no confiables que se pasan a la pantalla, como valores rellenados previamente a partir de parámetros de URL.

Example

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

useUser · () => UserMembers

Este hook proporciona información sobre el usuario activo, incluidos username, email y los métodos de autenticación disponibles.

Example

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

useMfaLoginOptions · MfaLoginOptionsMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla mfa-login-options.

​

Métodos

enroll · Promise<void>

Este método selecciona el factor de MFA especificado y avanza el flujo de inicio de sesión hasta la pantalla de desafío de ese factor.

Example

import { useMfaLoginOptions } from '@auth0/auth0-acul-react/mfa-login-options';

function LoginOptions() {
  const { enroll } = useMfaLoginOptions();
  return (
    <button onClick={() => enroll({ action: 'totp' })}>
      Usar la aplicación de autenticación
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

LoginEnrollOptions.

action · string · requerido

La acción que indica en qué factor inscribirse. Uno de “push-notification”, “otp”, “sms”, “phone”, “voice”, “email”, “recovery-code”, “webauthn-roaming”, “webauthn-platform” o “duo”.

returnToPrevious · Promise<void>

Este método vuelve a la pantalla anterior del flujo de autenticación.

Example

import { useMfaLoginOptions } from '@auth0/auth0-acul-react/mfa-login-options';

function BackButton() {
  const { returnToPrevious } = useMfaLoginOptions();
  return (
    <button onClick={() => returnToPrevious()}>
      Atrás
    </button>
  );
}

​

Hooks comunes y utilitarios

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración plana del contexto de marca.

useChangeLanguage · Hooks

Este hook devuelve una función para cambiar el idioma mostrado en la pantalla actual de ACUL.

useCurrentScreen · Hooks

Este hook obtiene el contexto y el estado de la pantalla actual.

useErrors · Hooks

Este hook lee y administra los errores de servidor, cliente y desarrollador en la pantalla.