Connexion

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

L’écran login permet à l’utilisateur de saisir son identifiant et son mot de passe. Selon votre locataire, cet identifiant peut être un courriel, un numéro de téléphone ou un nom d’utilisateur. Il prend également en charge l’authentification par l’intermédiaire de fournisseurs d’identité fédérés.

​

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’utilisation.
• L’importation à la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez qu’une version unifiée gère 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,
  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 contextuelles d’Auth0 sur l’écran login. Importez-les depuis @auth0/auth0-acul-react/login.

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

Example

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

useClient · () => ClientMembers

Ce hook fournit les configurations liées à l’application, 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 des renseignements sur l’Organisation de l’utilisateur si la connexion s’effectue dans le contexte d’une Organisation. Renvoie null lorsqu’aucun contexte d’Organisation 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 l’invite en cours 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 locataire, 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 connexions 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 expose les données non fiables transmises à l’écran, comme un nom d’utilisateur prérempli à partir des 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, notamment 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 tout le contexte disponibles pour l’écran login.

​

Méthodes

federatedLogin · Promise<void>

Cette méthode lance l’authentification via un fournisseur d’identité fédéré, comme Google ou GitHub.

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

options

FederatedLoginPayloadOptions.

connection · string · requis

Le nom de la connexion sociale à utiliser (p. ex. google-oauth2, github).

login · Promise<void>

Cette méthode envoie les identifiants 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 le courriel à utiliser pour l’authentification.

password · string · requis

Le mot de passe utilisé pour l’authentification.

captcha? · string

Valeur du captcha requise lorsque la détection de robots est activée pour le locataire.

[`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 ouvre le sélecteur d’indicatif 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>
  );
}

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

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de modifier 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 permet de lire et de gérer les erreurs du serveur, côté client et du développeur sur l’écran.

useLoginIdentifiers · Hooks

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