OrganizationSelection

Décrit tous les hooks et toutes les méthodes offerts pour personnaliser l’écran organization-selection de Universal Login.

L’écran organization-selection s’affiche lorsqu’un utilisateur doit saisir le nom de son organisation pour poursuivre le flux d’authentification. Il lui permet de saisir ce nom et de continuer.

​

Importation

Chaque écran possède son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’importation partielle et l’importation racine pour chaque écran.

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’usage.
• L’importation racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez une compilation unifiée capable de gérer tous les écrans possibles.

Import Example

// importation racine
import { useOrganizationSelection } from '@auth0/auth0-acul-react';

// importation partielle
import {
  useOrganizationSelection,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  continueWithOrganizationName,
} from '@auth0/auth0-acul-react/organization-selection';

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

​

Context Hooks

Hooks propres à l’écran qui fournissent un accès en lecture seule aux données de contexte d’Auth0 sur l’écran organization-selection. Importez-les depuis @auth0/auth0-acul-react/organization-selection.

useBranding · () => BrandingMembers

Ce hook fournit des configurations d’image de marque, comme le logo, les couleurs et les paramètres du thème affichés sur l’écran organization-selection.

Example

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

useClient · () => ClientMembers

Ce hook fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran organization-selection.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’organisation de l’utilisateur si la sélection est limitée à une organisation. Retourne null lorsqu’aucun contexte d’organisation n’est présent.

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

Ce hook contient des données sur le prompt actuel dans le flux d’authentification.

Example

import { usePrompt } from '@auth0/auth0-acul-react/organization-selection';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnOrganizationSelection

Ce hook contient des détails propres à l’écran organization-selection, y compris sa configuration et son contexte.

Example

import { useScreen } from '@auth0/auth0-acul-react/organization-selection';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

Ce hook contient des données liées au tenant, comme id et les métadonnées associées.

Example

import { useTenant } from '@auth0/auth0-acul-react/organization-selection';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran organization-selection, comme les connexions actives et l’état actuel du flux.

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme les paramètres préremplis provenant de la chaîne de requête de l’URL.

Example

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

useUser · () => UserMembers

Ce hook fournit des informations sur l’utilisateur actif, notamment username, email et les méthodes d’authentification disponibles.

Example

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

useOrganizationSelection · OrganizationSelectionMembers

Ce hook renvoie toutes les méthodes et le contexte disponibles dans l’écran organization-selection.

​

Méthodes

continueWithOrganizationName · Promise<void>

Cette méthode transmet le nom de l’organisation saisi par l’utilisateur et poursuit le flux d’authentification.

Example

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

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

Paramètres de la méthode

Afficher Paramètres

options

ContinueWithOrganizationNameOptions.

organizationName · string · requis

Le nom de l’organisation avec laquelle poursuivre.

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook obtient les options du thème actuel avec une configuration aplatie à partir du contexte d’image de marque.

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de changer la langue d’affichage sur l’écran ACUL actuel.

useCurrentScreen · Hooks

Ce hook obtient le contexte et l’état de l’écran actuel.

useErrors · Hooks

Ce hook lit et gère les erreurs côté serveur, côté client et côté développeur sur l’écran.