Consentimiento personalizado

Describe todos los hooks y métodos disponibles para personalizar la pantalla customized-consent de Universal Login.

La pantalla customized-consent se muestra durante el flujo de autorización cuando un usuario debe conceder o denegar permisos a una aplicación con una experiencia de consentimiento personalizada. Muestra los alcances solicitados y permite al usuario aceptar o rechazar la solicitud de consentimiento.

​

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 compilación unificada para gestionar todas las pantallas posibles.

Import Example

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

// importación parcial
import {
  useCustomizedConsent,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  accept,
  deny,
} from '@auth0/auth0-acul-react/customized-consent';

function CustomizedConsentScreen() {
  const { accept, deny } = useCustomizedConsent();
  return (
    <>
      <button onClick={() => accept()}>Accept</button>
      <button onClick={() => deny()}>Deny</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 customized-consent. Impórtalos desde @auth0/auth0-acul-react/customized-consent.

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 customized-consent.

Example

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

useClient · () => ClientMembers

Este hook proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla customized-consent.

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnCustomizedConsent

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

Example

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

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla customized-consent, como las conexiones activas y el estado actual del flujo.

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook proporciona acceso a los datos no confiables que se pasan a la pantalla, como los parámetros precargados de la cadena de consulta de la URL.

Example

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

useCustomizedConsent · CustomizedConsentMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla customized-consent.

​

Métodos

accept · Promise<void>

Este método registra el consentimiento del usuario y concede a la aplicación los permisos solicitados.

Example

import { useCustomizedConsent } from '@auth0/auth0-acul-react/customized-consent';

function AcceptButton() {
  const { accept } = useCustomizedConsent();
  return (
    <button onClick={() => accept()}>
      Accept
    </button>
  );
}

deny · Promise<void>

Este método rechaza la solicitud de consentimiento y revoca los permisos solicitados de la aplicación.

Example

import { useCustomizedConsent } from '@auth0/auth0-acul-react/customized-consent';

function DenyButton() {
  const { deny } = useCustomizedConsent();
  return (
    <button onClick={() => deny()}>
      Deny
    </button>
  );
}

​

Hooks comunes/utilitarios

useAuth0Themes · Hooks

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

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 administrar los errores de servidor, cliente y desarrollador en la pantalla.