OrganizationSelection

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran organization-selection d’Universal Login.

La classe OrganizationSelection implémente la fonctionnalité de l’écran organization-selection. Cet écran permet aux utilisateurs de sélectionner une organisation afin de continuer.

​

Constructeurs

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

Example

import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelectionManager = new OrganizationSelection();
await organizationSelectionManager.continueWithOrganizationName({
  organizationName: 'testOrganizationName',
});

​

Propriétés

branding · BrandingMembers

Fournit la configuration liée à l’image de marque, notamment le thème et les paramètres associés.

client · ClientMembers

Fournit la configuration de l’application, comme id, name et logoUrl, pour l’écran organization-selection.

organization · OrganizationMembers

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

prompt · PromptMembers

Contient des données sur l’invite actuelle du flux d’authentification.

screen · ScreenMembersOnOrganizationSelection

Contient les détails propres à l’écran organization-selection, y compris sa configuration et son contexte.

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme les entrées de l’utilisateur pendant le flux de sélection de l’organisation.

user · UserMembers

Renseignements sur 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 OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelectionManager = new OrganizationSelection();
organizationSelectionManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

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

persist? · "session"

Lorsque la valeur est définie à 'session', la langue sélectionnée est conservée pendant toute la durée de la session.

continueWithOrganizationName · Promise<void>

Cette méthode poursuit le flux avec le nom de l’organisation sélectionnée.

Example

import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelectionManager = new OrganizationSelection();
await organizationSelectionManager.continueWithOrganizationName({
  organizationName: 'testOrganizationName',
});

Paramètres de la méthode

Afficher Paramètres

options

ContinueWithOrganizationNameOptions.

organizationName · string · requis

Le nom de l’organisation à utiliser pour continuer.

getErrors · Error []

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