Back to Tooljet

User Lifecycle

docs/versioned_docs/version-2.2.0/user-authentication/user-lifecycle.md

3.20.154-lts5.4 KB
Original Source

User Lifecycle

Single-Workspace

User onboarding

  • If no user is present in the system, there will be Sign-up option in the login page. User can sign up by entering their email address. Tooljet will be sending a welcome email with activation URL to the email address. User can follow the activation URL and onboard to ToolJet.

    <div style={{textAlign: 'center'}}>

    </div>
  • User with admin privileges can invite members

    <div style={{textAlign: 'center'}}>

    </div>
  • Invited user will receive welcome email with activation URL, unregistered user can follow the link and setup Tooljet account

    <div style={{textAlign: 'center'}}>

    </div>
  • Invited user can onboard through SSO login, without using an invitation link

    <div style={{textAlign: 'center'}}>

    </div>
  • If enable signup option in enabled in SSO general settings, user can setup account through SSO login without an invite

    <div style={{textAlign: 'center'}}>

    </div>

Archive user

  • User can be archived by workspace admin from using Manage User page

    <div style={{textAlign: 'center'}}>

    </div>

Unarchive user

  • User can be unArchived by workspace admin from using Manage User page

    <div style={{textAlign: 'center'}}>

    </div>

:::info Archive or unarchive will affect user login, user won't be able to login using email id and password unless user is in active state :::

Multi-Workspace

:::info Check Multi-workspace docs here. :::

User onboarding

  • User can sign up using the sign up link provided on the login page, user will receive a welcome email with activation link. New workspace will be created for the user.

    <div style={{textAlign: 'center'}}>

    </div>
  • Users can be added to multiple workspaces. Users can create their own workspaces and manage them.

    <div style={{textAlign: 'center'}}>

    </div>
  • Existing user in active state for a workspace can be invited and on boarded to other workspaces, User will receive an invitation email with join link. If a user does not exist in the system, then they will receive a welcome email to setup the account, user can follow the link and on setup the account, once its done the user will be assigned to the new workspace created for the user.

    <div style={{textAlign: 'center'}}>

    </div>
  • Invited user can onboard through SSO login, without using an invitation link from the workspace login page

    <div style={{textAlign: 'center'}}>

    </div>
  • If enable sign up option in enabled in SSO general settings for the workspace, user can setup account through SSO login without an invite from the workspace login page

    <div style={{textAlign: 'center'}}>

    </div>

Archive user

  • User can be archived by workspace admin from using Manage User page

    <div style={{textAlign: 'center'}}>

    </div>

Unarchive user

  • User can be unarchive by workspace admin from using Manage User page

    <div style={{textAlign: 'center'}}>

    </div>

:::info Archive or unarchive will not affect user login, user can login and use other workspaces where user is in active state. :::

Switch between workspaces

<div style={{textAlign: 'center'}}>

</div>

User status

StatusAble to log inHow to activate
activeYes
invitedNo (Yes with SSO)Login through SSO or invitation link
archivedNoNot able to activate. Invite from Manage Users page, status will be changed to invited

Multi-Workspace SSO flow

  • Diagram shows how SSO configurations are chosen in common login page and workspace login page. Instance level SSO is configured in environment variables and Workspace level SSO is configured in respective Manage SSO page.
<div style={{textAlign: 'center'}}>
![ToolJet - SSO Flow](/img/user-lifecycle/sso-flow.png)
</div>