Consentimiento

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

La pantalla consent se muestra durante el flujo de autorización cuando un usuario debe conceder o denegar permisos a una aplicación. 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 paquete, lo que resulta útil cuando quieres una compilación unificada para gestionar todas las pantallas posibles.

Import Example

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

// importación parcial
import {
  useConsent,
  // 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/consent';

function ConsentScreen() {
  const { accept, deny } = useConsent();
  return (
    <>
      <button onClick={() => accept()}>Accept</button>
      <button onClick={() => deny()}>Deny</button>
    </>
  );
}

​

Hooks de contexto

Hooks específicos de la pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla consent. Impórtalos desde @auth0/auth0-acul-react/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 consent.

Example

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

useClient · () => ClientMembers

Este hook proporciona la configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla consent.

Example

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

useScreen · () => ScreenMembersOnConsent

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook contiene los datos no confiables que se pasan a la pantalla, como los parámetros rellenados previamente de las cadenas de consulta de la URL.

Example

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

useConsent · ConsentMembers

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

​

Métodos

accept · Promise<void>

Este método envía el consentimiento del usuario y otorga a la aplicación los permisos solicitados.

Example

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

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

deny · Promise<void>

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

Example

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

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

​

Hooks comunes y utilitarios

useAuth0Themes · Hooks

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