OrganizationSelection

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

La pantalla organization-selection se muestra cuando un usuario debe introducir el nombre de la organización para continuar el flujo de autenticación. Permite escribir el nombre de su organización y continuar.

​

Importación

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

• La importación parcial le permite incluir solo el code que necesita para su caso de uso.
• 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 desde la raíz
import { useOrganizationSelection } from '@auth0/auth0-acul-react';

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

function OrganizationSelectionScreen() {
  const { continueWithOrganizationName } = useOrganizationSelection();
  return (
    <button onClick={() => continueWithOrganizationName({ organizationName: 'my-org' })}>Continue</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 organization-selection. Impórtalos desde @auth0/auth0-acul-react/organization-selection.

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 organization-selection.

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si la selección se realiza en el ámbito de una Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnOrganizationSelection

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useOrganizationSelection · OrganizationSelectionMembers

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

​

Métodos

continueWithOrganizationName · Promise<void>

Este método envía el nombre de la organización que introdujo el usuario y continúa el flujo de autenticación.

Example

import { useOrganizationSelection } from '@auth0/auth0-acul-react/organization-selection';

function ContinueButton() {
  const { continueWithOrganizationName } = useOrganizationSelection();
  return (
    <button onClick={() => continueWithOrganizationName({ organizationName: 'my-org' })}>
      Continue
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ContinueWithOrganizationNameOptions.

organizationName · string · requerido

El nombre de la organización con el que continuar.

​

Hooks comunes y utilitarios

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración aplanada 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.