LoginPassword

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

L’écran login-password recueille le mot de passe de l’utilisateur à la deuxième étape d’un flux d’authentification où l’identifiant est demandé d’abord. Il permet aussi de basculer vers un fournisseur d’identité fédéré ou une autre connexion.

​

Import

Chaque écran possède son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’import partiel et l’import racine pour chaque écran.

• L’import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’import racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’un build unifié gère tous les écrans possibles.

Import Example

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

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

function LoginPasswordForm() {
  const { login } = useLoginPassword();
  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-password. Importez-les depuis @auth0/auth0-acul-react/login-password.

useBranding · () => BrandingMembers

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

Example

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

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des informations sur l’organisation de l’utilisateur si la connexion est limitée à une organisation. Renvoie null lorsqu’aucun contexte d’organisation n’est disponible.

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnLoginPassword

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

Example

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

useTransaction · () => TransactionMembersOnLoginPassword

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook expose 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-password';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

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

useLoginPassword · LoginPasswordMembers

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

​

Méthodes

federatedLogin · Promise<void>

Cette méthode déclenche l’authentification par l’intermédiaire d’un fournisseur d’identité fédéré, comme Google ou GitHub.

Example

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

function SocialButton() {
  const { federatedLogin } = useLoginPassword();
  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 soumet les informations d’identification de l’utilisateur pour terminer l’authentification à l’écran login-password.

Example

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

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

Paramètres de la méthode

Afficher Paramètres

options

LoginPasswordOptions.

username · string · requis

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

password · string · requis

Le mot de passe à utiliser pour l’authentification.

captcha? · string

Valeur du captcha requise lorsque la détection des 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').

switchConnection · Promise<void>

Cette méthode bascule vers une autre connexion d’authentification sans redémarrer le flux.

Example

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

function ConnectionSwitcher() {
  const { switchConnection } = useLoginPassword();
  return (
    <button onClick={() => switchConnection({ connection: 'enterprise-saml' })}>
      Use SSO
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SwitchConnectionOptionsLoginPassword.

connection · string · requis

Le nom de la connexion vers laquelle basculer. Utilisez ‘email’ ou ‘sms’ pour Passwordless, ou un nom de connexion de base de données pour l’authentification par mot de passe.

[`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 du thème actuel avec une configuration à 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 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 affichées à l’écran.