AcceptInvitation

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

La classe AcceptInvitation implémente la fonctionnalité de l’écran accept-invitation. Cet écran s’affiche lorsqu’un utilisateur doit accepter une invitation pour se joindre à une organisation.

​

Constructeurs

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

Example

import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';
const acceptInvitationManager = new AcceptInvitation();
await acceptInvitationManager.acceptInvitation();

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

Contient des données sur le prompt actuel dans le flux d’authentification.

screen · ScreenMembersOnAcceptInvitation

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

Fournit des données propres à la transaction pour l’écran accept-invitation, 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 d’acceptation de l’invitation.

user · UserMembers

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

​

Méthodes

acceptInvitation · Promise<void>

Cette méthode accepte l’invitation et ajoute l’utilisateur à l’organisation.

Example

import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';
const acceptInvitationManager = new AcceptInvitation();
await acceptInvitationManager.acceptInvitation();

changeLanguage · Promise<void>

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

Example

import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';
const acceptInvitationManager = new AcceptInvitation();
acceptInvitationManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue (locale) souhaité (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.

getErrors · Error []

Cette méthode récupère le tableau des erreurs de transaction dans le contexte, ou un tableau vide s’il n’en existe aucune.