UserStore

Collection of Rulecube User-related functions.

Methods

invite

invite(email: string, options: { accessExpirationDate?: Date | string, roles: string[] })

Creates a user with the given email and options.

Parameters

email string

The email of the user.

options { accessExpirationDate?: Date | string, roles: string[] }

The object containing the user options.

Return type

{userId: string, success: boolean, errorMessage?: string }

Examples

UserStore.invite('[email protected]', { accessExpirationDate: TODAY().addDays(30), roles: ['WorkspaceUser'] })

getByEmail

getByEmail(email: string)

Gets a user by email.

Parameters

email string

The email of the user.

Return type

{ [key: string]: any; }

Examples

UserStore.getByEmail('[email protected]')