Confirmation du code de l’appareil

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran device-code-confirmation de Universal Login.

L’écran device-code-confirmation s’affiche pendant le flux d’autorisation d’appareil. Il présente à l’utilisateur un code à confirmer et lui demande d’approuver ou de refuser la demande d’activation de l’appareil.

​

Import

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

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation depuis la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’un build unifié prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useDeviceCodeConfirmation,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  confirm,
  cancel,
} from '@auth0/auth0-acul-react/device-code-confirmation';

function DeviceCodeConfirmationScreen() {
  const { confirm, cancel } = useDeviceCodeConfirmation();
  return (
    <>
      <button onClick={() => confirm()}>Confirm</button>
      <button onClick={() => cancel()}>Cancel</button>
    </>
  );
}

​

Hooks de contexte

Hooks associés à l’écran qui fournissent un accès en lecture seule aux données de contexte Auth0 pour l’écran device-code-confirmation. Importez-les depuis @auth0/auth0-acul-react/device-code-confirmation.

useBranding · () => BrandingMembers

Ce hook fournit la configuration d’image de marque, comme le logo, les couleurs et les paramètres de thème affichés sur l’écran device-code-confirmation.

Example

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

useClient · () => ClientMembers

Ce hook fournit la configuration liée à l’application, comme id, name et logoUrl, pour l’écran device-code-confirmation.

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/device-code-confirmation';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

Ce hook contient des données sur l’invite en cours dans le flux d’authentification.

Example

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

useScreen · () => ScreenMembersOnDeviceCodeConfirmation

Ce hook contient des renseignements propres à l’écran device-code-confirmation, y compris sa configuration et son contexte.

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook traite les données non fiables transmises à l’écran, comme un code d’appareil prérempli à partir des paramètres de l’URL.

Example

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

useUser · () => UserMembers

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

Example

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

useDeviceCodeConfirmation · DeviceCodeConfirmationMembers

Ce hook renvoie toutes les méthodes et tout le contexte disponibles dans l’écran device-code-confirmation.

​

Méthodes

cancel · Promise<void>

Cette méthode annule le flux de code d’appareil et refuse la demande d’activation.

Example

import { useDeviceCodeConfirmation } from '@auth0/auth0-acul-react/device-code-confirmation';

function CancelButton() {
  const { cancel } = useDeviceCodeConfirmation();
  return (
    <button onClick={() => cancel()}>
      Cancel
    </button>
  );
}

confirm · Promise<void>

Cette méthode confirme le code d’appareil et approuve la demande d’activation.

Example

import { useDeviceCodeConfirmation } from '@auth0/auth0-acul-react/device-code-confirmation';

function ConfirmButton() {
  const { confirm } = useDeviceCodeConfirmation();
  return (
    <button onClick={() => confirm()}>
      Confirm
    </button>
  );
}

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel ainsi qu’une configuration mise à plat issue du contexte d’image de marque.

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

Ce hook récupère le contexte et l’état de l’écran actuel.

useErrors · Hooks

Ce hook lit et gère les erreurs du serveur, côté client et de développement affichées à l’écran.