LoginId

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

L’écran login-id recueille l’identifiant de l’utilisateur comme première étape d’un flux d’authentification qui commence par la saisie de l’identifiant. 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 la connexion par clé d’accès, les fournisseurs d’identité fédérés et Google One Tap.

​

Importation

Chaque écran a 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 une build unifiée capable de gérer tous les écrans possibles.

Import Example

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

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

function LoginIdForm() {
  const { login } = useLoginId();
  return (
    <button onClick={() => login({ username: '[e-mail]' })}>
      Continue
    </button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

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

Example

import { useBranding } from '@auth0/auth0-acul-react/login-id';
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-id.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit de l’information sur l’Organization de l’utilisateur si la connexion est limitée à une Organization. Retourne null lorsqu’aucun contexte d’Organization n’est présent.

Example

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

useScreen · () => ScreenMembersOnLoginId

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

Example

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

useTransaction · () => TransactionMembersOnLoginId

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useLoginId · LoginIdMembers

Ce hook renvoie toutes les méthodes et tout le contexte disponibles sur l’écran login-id.

​

Méthodes

googleOneTap · Promise<void>

Cette méthode authentifie l’utilisateur à l’aide d’un identifiant Google One Tap, ce qui permet une connexion en un clic sans redirection vers une page de connexion distincte.

Example

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

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

Paramètres de la méthode

Afficher Paramètres

one_tap_credential · string · requis

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

federatedLogin · Promise<void>

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

Example

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

function SocialButton() {
  const { federatedLogin } = useLoginId();
  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 la connexion du fournisseur d’identité sociale ou d’entreprise.

login · Promise<void>

Cette méthode soumet l’identifiant de l’utilisateur pour passer à l’étape suivante du flux d’authentification.

Example

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

function LoginIdForm() {
  const { login } = useLoginId();
  return (
    <button onClick={() => login({ username: '[e-mail]' })}>
      Continue
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

LoginOptions.

username · string · requis

L’identifiant (adresse courriel, numéro de téléphone ou nom d’utilisateur) à utiliser pour s’authentifier.

captcha? · string

Valeur 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').

passkeyLogin · Promise<void>

Cette méthode lance l’authentification sans mot de passe à l’aide d’une clé d’accès.

Example

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

function PasskeyButton() {
  const { passkeyLogin } = useLoginId();
  return (
    <button onClick={() => passkeyLogin()}>
      Sign in with Passkey
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

CustomOptions.

[`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 redirige vers le sélecteur d’indicatif de pays pour les flux de connexion par téléphone.

Example

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

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

​

Hooks utilitaires communs

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration à plat provenant 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 récupère le contexte et l’état de l’écran actuel.

useErrors · Hooks

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

useLoginIdentifiers · Hooks

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

usePasskeyAutofill · Hooks

Ce hook active le remplissage automatique par clé d’accès dans un champ de saisie pour une expérience de connexion sans mot de passe fluide.