LoginId

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran login-id de Universal Login.

La classe LoginId implémente la fonctionnalité de l’écran login-id. Cet écran recueille l’identifiant de l’utilisateur comme première étape d’un flux d’authentification où l’identifiant est saisi en premier. Selon votre tenant, cet identifiant peut être une adresse courriel, un numéro de téléphone ou un nom d’utilisateur. Il prend également en charge la connexion par clé d’accès, les fournisseurs d’identité fédérés et Google One Tap.

​

Constructeurs

Créez une instance du gestionnaire d’écran LoginId :

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.getLoginIdentifiers();

​

Propriétés

branding · BrandingMembers

Fournit des configurations liées à l’image de marque, comme le thème et les paramètres.

client · ClientMembers

Fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran login-id.

organization · OrganizationMembers

Fournit des renseignements sur l’Organization de l’utilisateur, comme id et name.

prompt · PromptMembers

Contient des données sur le prompt actuel dans le flux d’authentification.

screen · ScreenMembersOnLoginId

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

tenant · TenantMembers

Contient des données liées au tenant, comme id et les métadonnées associées.

transaction · TransactionMembersOnLoginId

Fournit des données propres à la transaction pour l’écran login-id, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant la connexion.

user · UserMembers

Renseignements sur l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode change la langue d’affichage de la page Universal Login.

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de locale de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’elle est définie à 'session', la langue sélectionnée est conservée pendant toute la durée de la session.

federatedLogin · Promise<void>

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

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.federatedLogin({
  connection: "google-oauth2"
});

Paramètres de la méthode

Afficher Paramètres

connection · string · requis

Le nom de la connexion du fournisseur d’identité social ou d’entreprise.

getErrors · Error []

Cette méthode récupère dans le contexte le tableau des erreurs de transaction, ou un tableau vide s’il n’y en a aucune. Elle renvoie un tableau d’objets d’erreur provenant du contexte de transaction.

getLoginIdentifiers · ScreenIdentifierType [] | null

Cette méthode récupère les types d’identifiant actifs pour l’écran login-id.

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.getLoginIdentifiers();

login · Promise<void>

Cette méthode invite l’utilisateur à saisir son nom d’utilisateur.

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.login({
  username: "testUser"
});

Paramètres de la méthode

Afficher Paramètres

options

LoginOptions.

username · string · requis

L’identifiant de l’utilisateur.

captcha? · string

Le code captcha ou la réponse du fournisseur de captcha. Cette propriété est requise si votre tenant Auth0 a Bot Detection activé.

[`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 authentifie l’utilisateur à l’aide de la clé d’accès fournie et, en cas de réussite, le redirige vers redirect_url.

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.passkeyLogin();

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

googleOneTap · Promise<void>

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

Vérifiez screen.googleOneTapConfig avant d’afficher l’invite Google One Tap — sa valeur est null lorsque la fonctionnalité n’est pas activée côté serveur.

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.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.

pickCountryCode · Promise<void>

Cette méthode redirige l’utilisateur vers la liste de sélection de l’indicatif de pays, où il peut mettre à jour l’indicatif de pays de son numéro de téléphone.

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.pickCountryCode();

registerPasskeyAutofill · Promise<void>

Cette méthode initialise une demande passive d’information d’identification WebAuthn à l’aide de navigator.credentials.get() avec mediation: conditional. Lorsque cette fonctionnalité est prise en charge, le navigateur peut afficher les clés d’accès enregistrées directement dans la liste déroulante d’autocomplétion du champ de nom d’utilisateur.

Example

import LoginId from '@auth0/auth0-acul-js/login-id';

async function initializeLogin() {
  const loginId = new LoginId();
  await loginId.registerPasskeyAutofill('username');
}

initializeLogin().catch(console.error);

Paramètres de la méthode

Afficher Paramètres

inputId? · string

ID facultatif de l’élément <input> du nom d’utilisateur (sans #). Exemple : "username". S’il est omis, le développeur doit s’assurer manuellement que les attributs autocomplete appropriés sont définis sur cet élément.