Login

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

La classe Login implémente les fonctionnalités de l’écran login. Cet écran permet à l’utilisateur de saisir son identifiant et son mot de passe. 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 l’authentification par l’intermédiaire de fournisseurs d’identité fédérés et de Google One Tap.

​

Constructeurs

Créez une instance du gestionnaire de l’écran de connexion :

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.login({
  username: "testUser",
  password: "testPassword"
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

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

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 · ScreenMembersOnLogin

Contient des détails propres à l’écran login, 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 · TransactionMembersOnLogin

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

untrustedData · UntrustedDataMembers

Traite les données non fiables transmises au SDK, comme les données saisies par l’utilisateur lors de la connexion.

user · UserMembers

Détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

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

Example

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

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code du paramètre régional pour la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

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

federatedLogin · Promise<void>

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

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.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 fournisseur d’identité d’entreprise.

getErrors · Error []

Cette méthode récupère, à partir du contexte, le tableau des erreurs de transaction, ou un tableau vide s’il n’y en a pas. Un tableau d’objets d’erreur issu du contexte de transaction.

getLoginIdentifiers · ScreenIdentifierType [] | null

Cette méthode renvoie les types d’identifiants actifs pour l’écran login.

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.getLoginIdentifiers();

login · Promise<void>

Cette méthode authentifie l’utilisateur à l’aide de l’identifiant et du mot de passe fournis.

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.login({
  username: "testUser",
  password: "testPassword"
});

Paramètres de la méthode

Afficher Paramètres

options

LoginPayloadOptions.

username · string · requis

L’identifiant de l’utilisateur.

password · string · requis

Le mot de passe de l’utilisateur.

captcha? · string

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

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Des champs personnalisés supplémentaires précédés de ulp- (par exemple, 'ulp-custom-field').

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.

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

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.googleOneTap({ one_tap_credential: credential });

Paramètres de la méthode

Afficher Paramètres

one_tap_credential · string · requis

Le jeton 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 Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.pickCountryCode();