OrganizationPicker

Describe todas las propiedades y los métodos disponibles para personalizar la pantalla organization-picker de Universal Login.

La clase OrganizationPicker implementa la funcionalidad de la pantalla organization-picker. Esta pantalla permite a los usuarios seleccionar una organización de una lista de organizaciones disponibles.

​

Constructores

Cree una instancia del administrador de la pantalla OrganizationPicker:

Example

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPickerManager = new OrganizationPicker();
await organizationPickerManager.selectOrganization({ organization: 'org_XXXXXXXXXXXXXXX' });

​

Propiedades

branding · BrandingMembers

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

client · ClientMembers

Proporciona configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla organization-picker.

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

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

tenant · TenantMembers

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

transaction · TransactionMembers

Proporciona datos específicos de la transacción para la pantalla organization-picker, 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 flujo de selección de organización.

user · UserMembers

Detalles del usuario activo, incluidos username, email y roles.

​

Métodos

changeLanguage · Promise<void>

Este método cambia el idioma de visualización de la página de Universal Login.

Example

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPickerManager = new OrganizationPicker();
organizationPickerManager.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 mantiene durante toda la sesión.

getErrors · Error []

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

selectOrganization · Promise<void>

Este método envía el ID de la organización seleccionada.

Example

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPickerManager = new OrganizationPicker();
await organizationPickerManager.selectOrganization({ organization: 'org_XXXXXXXXXXXXXXX' });

Parámetros del método

Mostrar Parámetros

options

SelectOrganizationOptions.

organization · string · requerido

El ID de la organización que se va a seleccionar.

state? · string

Un valor de estado opcional para incluir en la solicitud.

skipOrganizationSelection · Promise<void>

Este método envía la acción para omitir la selección de la organización.

Example

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPickerManager = new OrganizationPicker();
await organizationPickerManager.skipOrganizationSelection();