OrganizationPicker

Décrit toutes les propriétés et méthodes offertes pour personnaliser l’écran organization-picker de Universal Login.

La classe OrganizationPicker implémente les fonctionnalités de l’écran organization-picker. Cet écran permet aux utilisateurs de sélectionner une organisation dans une liste d’organisations offertes.

​

Constructeurs

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

Example

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

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran organization-picker.

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 dans le flux d’authentification.

screen · ScreenMembers

Contient des détails propres à l’écran organization-picker, notamment 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-picker, 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 le flux de sélection de l’organisation.

user · UserMembers

Contient les détails de l’utilisateur actif, notamment username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

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

Exemple

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPickerManager = new OrganizationPicker();
organizationPickerManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

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

persist? · "session"

Lorsque cette valeur est définie sur 'session', la langue sélectionnée est conservée pendant toute la session.

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.

selectOrganization · Promise<void>

Cette méthode soumet l’id de l’organisation sélectionnée.

Exemple

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

Paramètres de la méthode

Afficher Paramètres

options

SelectOrganizationOptions.

organization · string · requis

L’id de l’organisation à sélectionner.

state? · string

Une valeur state facultative à inclure dans la requête.

skipOrganizationSelection · Promise<void>

Cette méthode soumet l’action permettant d’ignorer la sélection de l’organisation.

Exemple

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