MfaPushWelcome

Describe todos los hooks y métodos disponibles para personalizar la pantalla mfa-push-welcome de Universal Login.

La pantalla mfa-push-welcome presenta al usuario la autenticación MFA mediante notificaciones push y le pide que se inscriba o que elija un autenticador diferente.

​

Importación

Cada pantalla tiene su propio conjunto de hooks y métodos. El SDK admite la importación parcial y la importación desde la raíz para cada pantalla.

• La importación parcial te permite incluir solo el código que necesitas para tu caso de uso.
• La importación desde la raíz te permite cargar todas las pantallas desde un único bundle, lo que resulta útil cuando quieres una build unificada que gestione todas las pantallas posibles.

Import Example

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

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

function MfaPushWelcomeScreen() {
  const { enroll } = useMfaPushWelcome();
  return (
    <button onClick={() => enroll()}>
      Set Up Push Notifications
    </button>
  );
}

​

Hooks de contexto

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

useBranding · () => BrandingMembers

Este hook proporciona la configuración de marca, como el logotipo, los colores y la configuración del tema que se muestran en la pantalla mfa-push-welcome.

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el flujo de MFA tiene alcance de Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnMfaPushWelcome

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook proporciona 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-push-welcome';
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-push-welcome';
function UserProfile() {
  const user = useUser();
}

useMfaPushWelcome · MfaPushWelcomeMembers

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

​

Métodos

enroll · Promise<void>

Este método inicia el flujo para inscribir al usuario en las notificaciones push.

Example

import { useMfaPushWelcome } from '@auth0/auth0-acul-react/mfa-push-welcome';

function EnrollButton() {
  const { enroll } = useMfaPushWelcome();
  return (
    <button onClick={() => enroll()}>
      Configurar notificaciones push
    </button>
  );
}

pickAuthenticator · Promise<void>

Este método lleva a la pantalla de selección de autenticador para que el usuario pueda elegir un método de MFA distinto.

Example

import { useMfaPushWelcome } from '@auth0/auth0-acul-react/mfa-push-welcome';

function PickAuthenticatorButton() {
  const { pickAuthenticator } = useMfaPushWelcome();
  return (
    <button onClick={() => pickAuthenticator()}>
      Elegir autenticador
    </button>
  );
}

​

Hooks comunes y de utilidad

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

Este hook permite leer y gestionar los errores del servidor, del cliente y de desarrollo en la pantalla.