Accept Invitation screen class

The Accept Invitation screen class provides methods associated with the invitation screen.

Import and instantiate the Accept Invitation screen class:

import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';
const acceptinvitation = new AcceptInvitation();

// SDK Properties return a string, number or boolean
// ex. "login-id"
acceptinvitation.screen.name;

// SDK Methods return an object or array
await acceptInvitation.acceptInvitation();

Was this helpful?

/

Properties

The Accept Invitation screen class properties are:

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

Was this helpful?

/

Methods

The Accept Invitation screen class method is:

acceptInvitation( options ?)

This method accepts the invitation to the organization.

import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';

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

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.