MfaPushChallengePush

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

La pantalla mfa-push-challenge-push le pide al usuario que apruebe una notificación push de MFA enviada a su dispositivo móvil.

​

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 le permite incluir solo el código que necesita para su caso de uso específico.
• La importación desde la raíz le permite cargar todas las pantallas desde un único paquete, lo que resulta útil cuando desea una compilación unificada para gestionar todas las pantallas posibles.

Import Example

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

// importación parcial
import {
  useMfaPushChallengePush,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useMfaPolling,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  continueMethod,
  enterCodeManually,
  resendPushNotification,
  tryAnotherMethod,
} from "@auth0/auth0-acul-react/mfa-push-challenge-push";

function MfaPushChallengePushScreen() {
  const { continueMethod } = useMfaPushChallengePush();
  return (
    <button onClick={() => continueMethod({})}>
      I've Approved
    </button>
  );
}

​

Hooks de contexto

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

useBranding · () => BrandingMembers

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

Example

import { useBranding } from '@auth0/auth0-acul-react/mfa-push-challenge-push';
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-challenge-push.

Example

import { useClient } from '@auth0/auth0-acul-react/mfa-push-challenge-push';
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 al ámbito de una organización. Devuelve null cuando no hay contexto de organización.

Example

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

useScreen · () => ScreenMembersOnMfaPushChallengePush

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembersOnMfaPushChallengePush

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaPushChallengePush · MfaPushChallengePushMembers

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

​

Métodos

continueMethod · Promise<void>

Este método completa el desafío push una vez que el usuario haya aprobado la notificación en su dispositivo móvil.

Example

import { useMfaPushChallengePush } from '@auth0/auth0-acul-react/mfa-push-challenge-push';

function ContinueButton() {
  const { continueMethod } = useMfaPushChallengePush();
  return (
    <button onClick={() => continueMethod({ rememberDevice: true })}>
      I've Approved
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

WithRememberOptions.

rememberDevice? · boolean

Si es true, se recordará el dispositivo y no se volverá a requerir MFA en él.

enterCodeManually · Promise<void>

Este método lleva a la pantalla de introducción manual del código para que el usuario pueda introducir un código OTP en lugar de usar la notificación push.

Example

import { useMfaPushChallengePush } from '@auth0/auth0-acul-react/mfa-push-challenge-push';

function EnterCodeButton() {
  const { enterCodeManually } = useMfaPushChallengePush();
  return (
    <button onClick={() => enterCodeManually()}>
      Enter Code Manually
    </button>
  );
}

resendPushNotification · Promise<void>

Este método vuelve a enviar la notificación push al dispositivo móvil del usuario.

Example

import { useMfaPushChallengePush } from '@auth0/auth0-acul-react/mfa-push-challenge-push';

function ResendButton() {
  const { resendPushNotification } = useMfaPushChallengePush();
  return (
    <button onClick={() => resendPushNotification({})}>
      Resend Notification
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

WithRememberOptions.

rememberDevice? · boolean

Si es true, se recordará el dispositivo y no se volverá a requerir MFA en él.

tryAnotherMethod · Promise<void>

Este método lleva a la pantalla de selección del método de MFA para que el usuario pueda elegir un factor de autenticación diferente.

Example

import { useMfaPushChallengePush } from '@auth0/auth0-acul-react/mfa-push-challenge-push';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaPushChallengePush();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Try Another Method
    </button>
  );
}

​

Hooks comunes y utilitarios

useMfaPolling · Hooks

Este hook gestiona el estado de sondeo de las pantallas que esperan una respuesta asíncrona a una notificación push.

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración consolidada 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 gestiona los errores del servidor, del cliente y del desarrollador en la pantalla.