Skip to main content
The AcceptInvitation class implements the accept-invitation screen functionality. This screen is displayed when a user needs to accept an invitation to join an organization.

​
Constructors

Create an instance of AcceptInvitation screen manager
Example
import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';

const acceptInvitation = new AcceptInvitation();
await acceptInvitation.acceptInvitation();

​
Properties

​
branding
BrandingMembers
Provides branding-related configurations, such as branding theme and settings.
​
client
ClientMembers
Provides client-related configurations, such as id, name, and logoUrl, for the accept-invitation screen.
​
organization
OrganizationMembers
Provides information about the user’s organization, such as organization id and name.
​
prompt
PromptMembers
Contains data about the current prompt in the authentication flow.
​
screen
ScreenMembersOnAcceptInvitation
Contains details specific to the accept-invitation screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembers
Provides transaction-specific data for the accept-invitation screen, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembers
Handles untrusted data passed to the SDK, such as user input during the invitation acceptance flow.
​
user
UserMembers
Details of the active user, including username, email, and roles.

​
Methods

​
acceptInvitation
(options ?)
This method accepts the invitation and adds the user to the organization.
Example
import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';

const acceptInvitation = new AcceptInvitation();
await acceptInvitation.acceptInvitation();
​
options
OPTIONAL
Optional payload.
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.