Consentement

Décrit tous les hooks et méthodes disponibles pour personnaliser l’écran consent de Universal Login.

L’écran consent s’affiche pendant le flux d’autorisation lorsqu’un utilisateur doit accorder ou refuser des autorisations à une application. Il présente les scopes demandés et permet à l’utilisateur d’accepter ou de refuser la demande de consentement.

​

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’utilisation.
• L’importation racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une build unifiée prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useConsent,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  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 contexte

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

useBranding · () => BrandingMembers

Ce hook fournit les paramètres d’image de marque, comme le logo, les couleurs et les paramètres de thème affichés sur l’écran consent.

Example

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

useClient · () => ClientMembers

Ce hook fournit les paramètres liés à l’application, comme id, name et logoUrl, pour l’écran consent.

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnConsent

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

Example

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

useTransaction · () => TransactionMembers

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

Example

import { useTransaction } from '@auth0/auth0-acul-react/consent';
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 des chaînes de requête de l’URL.

Example

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

useUser · () => UserMembers

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

Example

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

useConsent · ConsentMembers

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

​

Méthodes

accept · Promise<void>

Cette méthode envoie le consentement de l’utilisateur et accorde à l’application les autorisations demandées.

Example

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

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

deny · Promise<void>

Cette méthode refuse la demande de consentement et retire à l’application les autorisations demandées.

Example

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

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

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options de thème actuelles avec une configuration mise à plat à partir du contexte d’image de marque.

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

Ce hook lit et gère les erreurs serveur, client et développeur à l’écran.