ContextQMD
Back to Tooljet

SAML

docs/versioned_docs/version-2.50.0-LTS/user-authentication/sso/saml.md

3.20.154-lts4.2 KB
Original Source

ToolJet supports SAML authentication for your workspace. The supported SAML providers are: Okta, Active Directory Federation Services, Azure AD, Auth0 and other SAML SSO providers.

<div style={{paddingTop:'24px'}}>

Configuring SAML

To enable SAML authentication, you need to configure the following workspace settings:

  1. Go to Workspace Settings > Workspace login.

  2. By default, SAML is disabled. Toggle it on to enable SAML authentication.

  3. Enter the following configuration details:

    • SAML Provider Name: Enter the name of your SAML provider. This name will be displayed on the login page.
    • Identity provider metadata: Upload the data from the metadata file provided by your SAML provider. This file contains the SAML configuration details.
    • Group Attribute: Enter the name of the attribute that contains the group information of the user. This attribute is used to map the user to the appropriate group.
    • Redirect URL: Copy the redirect URL provided and paste it in the SAML provider's configuration page.

:::tip Downloading the metadata from your identity provider Generally, the metadata is available in the form of an XML file which can be downloaded from your identity provider's dashboard.

 Copy the metadata from the XML file and paste it into the ToolJet's SAML SSO configuration settings. Please ensure that the metadata is pasted in the correct format, as it contains essential configuration details from the identity provider necessary for authentication.

 Additionally, you can often find this data by navigating to https://&ltyour-identity-provider&gt/federationmetadata/2007-06/federationmetadata.xml

:::

  1. Once configured, click Save Changes.
</div> :::tip SAML for multiple workspaces
  • The multiple workspaces feature is available only in versions v2.50.9.46-lts and later.
  • Configure the required environment variables as below:
variablevalue
SAML_SET_ENTITY_ID_REDIRECT_URLtrue
TOOLJET_SERVER_URL<URL must be the same as the ToolJet host>
   :::

:::tip SAML for Google and Azure Configure the required environment variable as follows:

variablevalue
SAML_SET_ENTITY_ID_SERVER_URLtrue
TOOLJET_SERVER_URL<URL must be the same as the ToolJet host>

Note: If you are using the multiple workspaces setting, you do not need to configure the SAML_SET_ENTITY_ID_SERVER_URL variable. :::

<div style={{paddingTop:'24px'}}>

Logging in with SAML

  1. Go to the Workspace login and copy the Login URL provided. Furthermore, you have the flexibility to choose whether to turn on 'Enable Signups' allowing users to signup without an invite. Through SSO authentication, we check if the user already exists; if so, they can sign in seamlessly. Otherwise, an error will be displayed. Conversely, with this option disabled, only invited users can log in, provided SSO authentication is successful.

  2. The Login URL obtained can be used to access the workspace. Please note that ToolJet supports SAML login at the workspace level, ensuring users are logged in specifically to the selected workspace.

    As a result, users can now log in to your workspace using the provided Login URL. The login page will prominently feature the name of the SAML provider configured in your workspace settings.

  3. Click on Sign in with SAML Name button and you will be redirected to the SAML provider's login page.

  4. Enter your credentials and click Login. If the user is signing in for the first time, they will be redirected to the ToolJet's onboarding page.

</div>