LoginPassword

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran login-password de 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 saisi en premier. Il permet aussi de passer à un fournisseur d’identité fédéré ou à une autre connexion.

​

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 dont vous avez besoin pour 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 voulez un build unifié pour gérer 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

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

useBranding · () => BrandingMembers

Ce hook fournit des paramètres d’image de marque, comme le logo, les couleurs et les réglages 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 des paramètres liés au client, 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 renseignements sur l’Organization de l’utilisateur si la connexion est scoped à l’Organization. Retourne null lorsqu’aucun contexte d’Organization n’est présent.

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 le prompt actuel 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, y compris 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 tenant, 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 gère les données non fiables transmises à l’écran, comme un identifiant prérempli à partir de 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, y compris le username, l’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 sur l’écran login-password.

​

Méthodes

federatedLogin · Promise<void>

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

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 connexion du fournisseur d’identité Social ou Enterprise.

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 s’authentifier.

password · string · requis

Le mot de passe d’authentification.

captcha? · string

Valeur captcha requise lorsque Bot Detection est activé sur le tenant.

[`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 l’authentification sans mot de passe, ou un nom de connexion de base de données pour l’authentification par mot de passe.

​

Hooks utilitaires communs

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration à plat provenant du contexte de l’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 côté serveur, côté client et de développement à l’écran.