LoginId

Describe todas las propiedades y métodos disponibles para personalizar la pantalla login-id de Universal Login.

La clase LoginId implementa la funcionalidad de la pantalla login-id. Esta pantalla solicita el identificador y la contraseña del usuario. Según tu inquilino, este identificador puede ser un correo electrónico, un número de teléfono o un username.

​

Constructores

Cree una instancia del administrador de la pantalla LoginId:

Example

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

​

Propiedades

branding · BrandingMembers

Proporciona la configuración de marca, como el tema y los ajustes de marca.

client · ClientMembers

Proporciona la configuración del cliente, como id, name y logoUrl, para la pantalla login-id.

organization · OrganizationMembers

Proporciona información sobre la organización del usuario, como id y name.

prompt · PromptMembers

Contiene datos sobre la pantalla actual del flujo de autenticación.

screen · ScreenMembersOnLoginId

Contiene detalles específicos de la pantalla login-id, incluida su configuración y su contexto.

tenant · TenantMembers

Contiene datos relacionados con el inquilino, como id y los metadatos asociados.

transaction · TransactionMembersOnLoginId

Proporciona datos específicos de la transacción para la pantalla login-id, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembers

Gestiona datos no confiables que se pasan al SDK, como la entrada del usuario durante el inicio de sesión.

user · UserMembers

Contiene los detalles del usuario activo, incluidos username, email y roles.

​

Métodos

changeLanguage · Promise<void>

Este método cambia el idioma que se muestra en la página de Universal Login.

Example

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

Parámetros del método

Mostrar Parámetros

options

LanguageChangeOptions.

language · string · requerido

El código de configuración regional del idioma deseado (por ejemplo, 'en', 'fr', 'es').

persist? · "session"

Cuando se establece en 'session', el idioma seleccionado se conserva durante toda la sesión.

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

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

federatedLogin · Promise<void>

Este método redirige al usuario al Proveedor de identidad (IdP) social o empresarial para autenticarse.

Example

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

Parámetros del método

Mostrar Parámetros

options

FederatedLoginPayloadOptions.

connection · string · requerido

El nombre de la conexión social que se debe usar.

getErrors · Error []

Este método recupera el array de errores de la transacción desde el contexto, o un array vacío si no existe ninguno. Devuelve un array de objetos de error del contexto de la transacción.

getLoginIdentifiers · ScreenIdentifierType [] | null

Este método obtiene los tipos de identificador activos para la pantalla login-id.

Example

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

login · Promise<void>

Este método solicita al usuario que proporcione su username.

Example

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

Parámetros del método

Mostrar Parámetros

options

LoginOptions.

username · string · requerido

El identificador del usuario.

captcha? · string

El código o la respuesta del captcha del proveedor correspondiente. Esta propiedad es obligatoria si tu inquilino de Auth0 tiene Bot Detection habilitado.

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

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

passkeyLogin · Promise<void>

Este método autentica al usuario con la passkey proporcionada y, si se completa correctamente, lo redirige a redirect_url.

Example

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

Parámetros del método

Mostrar Parámetros

options

CustomOptions.

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

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

pickCountryCode · Promise<void>

Este método redirige al usuario a la lista de selección de códigos de país, donde puede actualizar el prefijo del código de país de su número de teléfono.

Example

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

Parámetros del método

Mostrar Parámetros

options

CustomOptions.

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

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

registerPasskeyAutofill · Promise<void>

Este método inicializa una solicitud pasiva de credenciales de WebAuthn mediante navigator.credentials.get() con mediation: conditional. Cuando es compatible, permite que el navegador muestre las passkeys almacenadas directamente en el menú desplegable de autocompletado del campo de username.

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);

Parámetros del método

Mostrar Parámetros

inputId? · string

ID opcional del elemento <input> del username (sin #). Ejemplo: "username". Si se omite, el desarrollador debe asegurarse manualmente de que el elemento input tenga los atributos autocomplete correctos.