Connexion

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

L’écran login recueille l’identifiant et le mot de passe de l’utilisateur. Selon votre tenant, cet identifiant peut être une adresse courriel, un numéro de téléphone ou un nom d’utilisateur. Il prend aussi en charge l’authentification par des fournisseurs d’identité fédérés et Google One Tap.

​

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 à la racine pour chaque écran.

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

Import Example

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

// importation partielle
import {
  useLogin,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useLoginIdentifiers,
  useChangeLanguage,
  // Méthodes  
  login,
  federatedLogin,
  googleOneTap,
  pickCountryCode,
} from "@auth0/auth0-acul-react/login";

function LoginForm() {
  const { login, federatedLogin } = useLogin();
  return (
    <button onClick={() => login({ username: "[e-mail]", password: "secret" })}>
      Sign In
    </button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit de l’information sur l’Organization de l’utilisateur si le login est associé à une Organization. Retourne null lorsqu’aucun contexte d’Organization n’est présent.

Example

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

useScreen · () => ScreenMembersOnLogin

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

Example

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

useTransaction · () => TransactionMembersOnLogin

Ce hook fournit des données propres à la transaction pour l’écran login, comme les connections actives, les méthodes de connexion disponibles et l’état actuel du flux.

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme un username prérempli à partir de paramètres d’URL.

Example

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

useUser · () => UserMembers

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

Example

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

useLogin · LoginMembers

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

​

Méthodes

googleOneTap · Promise<void>

Cette méthode authentifie l’utilisateur à l’aide d’une information d’identification Google One Tap, ce qui permet de se connecter en un clic sans être redirigé vers une page de connexion distincte.

Example

import { useLogin } from '@auth0/auth0-acul-react/login';

function GoogleOneTapHandler({ credential }) {
  const { googleOneTap } = useLogin();
  return googleOneTap({ one_tap_credential: credential });
}

Paramètres de la méthode

Afficher Paramètres

one_tap_credential · string · requis

Le jeton d’information d’identification Google One Tap renvoyé par l’invite Google Identity Services.

federatedLogin · Promise<void>

Cette méthode redirige l’utilisateur vers le Social ou le fournisseur d’identité Enterprise (IdP) pour l’authentification.

Example

import { useLogin } from '@auth0/auth0-acul-react/login';

function SocialButton() {
  const { federatedLogin } = useLogin();
  return (
    <button onClick={() => federatedLogin({ connection: 'google-oauth2' })}>
      Sign in with Google
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

connection · string · requis

Le nom de connexion du fournisseur d’identité Social ou Enterprise.

login · Promise<void>

Cette méthode envoie les informations d’identification de l’utilisateur pour terminer l’authentification sur l’écran login.

Example

import { useLogin } from '@auth0/auth0-acul-react/login';

function LoginForm() {
  const { login } = useLogin();
  return (
    <button onClick={() => login({ username: '[e-mail]', password: 'secret' })}>
      Sign In
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

LoginPayloadOptions.

username · string · requis

Le nom d’utilisateur ou l’adresse courriel à utiliser pour s’authentifier.

password · string · requis

Le mot de passe utilisé pour l’authentification.

captcha? · string

Valeur du captcha requise lorsque la détection de bots est activée sur le tenant.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Champs personnalisés supplémentaires préfixés par ulp- (par exemple, 'ulp-custom-field').

pickCountryCode · Promise<void>

Cette méthode mène au sélecteur de code de pays pour les flux de connexion par téléphone.

Example

import { useLogin } from '@auth0/auth0-acul-react/login';

function PhoneLogin() {
  const { pickCountryCode } = useLogin();
  return (
    <button onClick={() => pickCountryCode()}>
      Select Country Code
    </button>
  );
}

​

Hooks utilitaires courants

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel à partir du contexte de l’image de marque, avec une configuration aplatie.

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

useLoginIdentifiers · Hooks

Ce hook renvoie la liste des types d’identifiant actifs (email, phone, username) dans le flux actuel.