diff --git a/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/auth0.md b/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/auth0.md index d1dcbd0b58..a2c7133561 100644 --- a/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/auth0.md +++ b/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/auth0.md @@ -10,18 +10,18 @@ To setup OIDC using Auth0, you can follow these steps: 1. Go to Auth0 Dashboard, navigate to the **Applications** section and click on _Create Application_. - Auth0: SSO + Auth0: SSO 2. Select **Regular Web Applications**. You can keep other settings unchanged and click on _Create_. Auth0: SSO 3. Go to **Settings** to get the **Client ID**, **Client Secret** and **Domain**. - Auth0: ToolJet Configuration + Auth0: ToolJet Configuration 4. Go to your **ToolJet Workspace settings > Workspace login** and enable **OpenID Connect**. (Example URL - https://app.corp.com/demo-workspace/workspace-settings/workspace-login) - Auth0: ToolJet Configuration + Auth0: ToolJet Configuration 5. Paste the Client ID and Client secret we got from step 3. 6. The [Well known URL](https://auth0.com/docs/get-started/applications/configure-applications-with-oidc-discovery#:~:text=You%20can%20configure%20applications%20with%20the%20OpenID%20Connect%20(OIDC)%20discovery%20documents%20found%20at%3A%20https%3A//%7ByourDomain%7D/.well%2Dknown/openid%2Dconfiguration) will be in the following format. You need to replace `` with the Auth0 Domain we got in step 3. @@ -33,4 +33,4 @@ To setup OIDC using Auth0, you can follow these steps: 8. Go to your **Auth0 application > Settings > Application URIs** and paste the Redirect URI in **Allowed Callback URLs** and save the configuration. You shall now be able to login to your ToolJet workspace using Auth0. - Sign-In Page \ No newline at end of file + Sign-In Page \ No newline at end of file diff --git a/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/azuread.md b/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/azuread.md index f0c94d8f58..3ed0905404 100644 --- a/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/azuread.md +++ b/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/azuread.md @@ -3,36 +3,6 @@ id: azuread title: Microsoft Entra ID --- - - Microsoft Entra ID can be configured as the Identity Provider for OIDC, which is an authentication protocol that securely verifies user identities through a trusted provider. This document explains how to obtain the required credentials from the Microsoft Azure Portal. Refer to the **[OIDC Setup](/docs/user-management/sso/oidc/setup)** guide to configure OIDC in your application. ## Generating Client ID and Client Secret on Microsoft Azure Portal @@ -47,13 +17,13 @@ Microsoft Entra ID can be configured as the Identity Provider for OIDC, which is 3. Go to [Microsoft Azure Portal](https://portal.azure.com) and navigate to [Manage Microsoft Entra ID](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview). 4. Register your application or create a new one by clicking on **Add > App Registration**. - App registration + App registration 5. Fill the details as per your requirements. In the Redirect URI, enter the Redirect URL you got from ToolJet and click on **Register**. - Register application + Register application 6. You can find the **Client ID** on the **Application's Overview tab**. To get the Client Secret, go to the application's **Overview tab > Manage > Client credentials > Add a certificate or secret > New client secret**. Copy the value field. - Client secret + Client secret 7. Enter the Client ID and Client Secret in the OIDC configuration modal in ToolJet. @@ -64,20 +34,20 @@ Microsoft Entra ID can be configured as the Identity Provider for OIDC, which is You can find the Directory (tenant) ID on the Overview tab of your application in Azure. You shall now be able to login to your ToolJet workspace using Microsoft Entra ID. - Sign-In Page + Sign-In Page ## Configuring Group Sync using Microsoft Entra ID 1. Go to Azure Portal > [Enterprise Applications](https://portal.azure.com/#view/Microsoft_AAD_IAM/StartboardApplicationsMenuBlade/~/AppAppsPreview) > Your application. 2. In the left panel, go to Manage > Single sign-on > Attributes & Claims > Edit > Add a group claim > Click on Go to Token configuration. - Token Configuration + Token Configuration 3. Click on Add groups claim > All groups (You can choose the group type according to your need) and click Add. A claim named **groups** will be created. - Groups Claim + Groups Claim 4. Go to Azure Portal > Groups > All groups. Select the group you want to create a mapping for and copy the Object ID. - Groups Object ID + Groups Object ID 5. Go to **ToolJet > Workspace Settings > Workspace login > OpenID Connect > Your Microsoft Entra ID OIDC Configuration > Enable Group Sync**. (Example URL - https://app.corp.com/demo-workspace/workspace-settings/workspace-login) @@ -88,4 +58,4 @@ You shall now be able to login to your ToolJet workspace using Microsoft Entra I ```js Object ID from Step 4 -> ToolJet group name ``` - Group Sync COnfiguration \ No newline at end of file + Group Sync COnfiguration \ No newline at end of file diff --git a/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/onelogin.md b/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/onelogin.md index d838e7350a..9dec01c91b 100644 --- a/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/onelogin.md +++ b/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/onelogin.md @@ -10,22 +10,22 @@ OneLogin can be configured as an identity provider (IdP) using OpenID Connect (O 1. Log in to [OneLogin](https://www.onelogin.com/). You'll need a domain for your organisation. You can get one by signing up for a **Free trial** on the home page. 2. Go to the Administration page, then navigate to **Applications > Applications > Add App**. - OneLogin: Add Application + OneLogin: Add Application 3. In the Find Applications page, search for OpenID Connect (OIDC) and Select OpenId Connect (OIDC). - OneLogin: Find Application + OneLogin: Find Application 4. Enter the Display Name and keep the default configuration and click on **Save**. 5. You'll need to create your user and add it to the OneLogin application that you just created. In the Naviagtion bar, go to Users > New User and create a user. After creating the user, open the user profile, go to Applications, and click the + icon to assign the user to the application you just created. - OneLogin: Assign Application to User + OneLogin: Assign Application to User 6. Select the application you just created and click **Continue**. The user will be added to the application. At this point, the OneLogin application is ready. Next, you’ll collect the OIDC credentials required to configure ToolJet. 7. Now go to your Application > **SSO** and get the Client ID. To get the Client secret, click on **Show client secret**. To get the Well-known configuration URL, click **Well-known Configuration** and copy the URL. - OneLogin: Configuration + OneLogin: Configuration 8. Go to ToolJet > Workspace settings > Workspace login > OpenID Connect > Add provider. (Example URL - https://app.corp.com/demo-workspace/workspace-settings/workspace-login) @@ -33,10 +33,10 @@ At this point, the OneLogin application is ready. Next, you’ll collect the OID 9. Enter the details from step 7 and click Save changes. Then, copy the Redirect URL shown by ToolJet. 10. Go to your OneLogin Application > Configuration > Paste the Redirect URL into the Redirect URIs section and click **Save**. - OneLogin: Redirect URL + OneLogin: Redirect URL You shall now be able to login to your ToolJet workspace using OneLogin. - Sign-In Page + Sign-In Page ## Configuring Group Sync with OneLogin @@ -45,20 +45,20 @@ To configure group sync with OneLogin, you need to follow these steps: 1. Go to the OneLogin Admin Portal and navigate to Users → Roles → New Role. Create a role with the same name as the group you want to map. For example, to map the builder role in OneLogin to developer in ToolJet, name the role builder. 2. Select your app to add to the role and click on Save. - OneLogin: Add Application To Role + OneLogin: Add Application To Role 3. Add the user to the role. Navigate to **Users > Roles > The role you created > Users**. Now check for the user, click **Add to role** and Save. - OneLogin: Add User To Role + OneLogin: Add User To Role 4. Go to Applications -> Your OneLogin Application -> Parameters. Now edit the Groups configuration as follows: - User Roles - Semicolon Delimited input (Multi-value output)

- OneLogin: Edit Field Groups + OneLogin: Edit Field Groups 5. Go to **Rules > Add Rule**. Enter a name of your choice for the rule.. Add a rule with the action: `Set Groups in Application > Map from OneLogin > For each > member_of > with value that matches > .*` - OneLogin: One Login Rule + OneLogin: One Login Rule 6. Go to your ToolJet Application. Navigate to Workspace settings > Workspace login > OpenID Connect > Your OneLogin Configuration and Enable group sync. @@ -69,6 +69,6 @@ To configure group sync with OneLogin, you need to follow these steps: -> ``` For example: If your OneLogin Role is **builder** and the ToolJet group name is **developer**, the mapping will be builder -> developer. - OneLogin: ToolJet Configuration + OneLogin: ToolJet Configuration Users will now be assigned to ToolJet groups based on their OneLogin roles. \ No newline at end of file diff --git a/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/saml/entra-id.md b/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/saml/entra-id.md index 03e2b7edd8..52234fbb77 100644 --- a/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/saml/entra-id.md +++ b/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/saml/entra-id.md @@ -10,21 +10,21 @@ Microsoft Entra ID can be configured as the Identity Provider for SAML, which is 1. Sign in to Azure Developer Portal. Navigate to Enterprise applications and create a new application. 2. Open the application and go to **Manage > Single sign-on > SAML**. - Entra ID: Create Application + Entra ID: Create Application 3. Under SAML Certificates, copy the App Federation Metadata URL. Open this URL in a new tab and copy the XML content. 4. In ToolJet, navigate to **Workspace settings > Workspace login > SAML**. Paste the XML into Identity provider metadata and click **Save changes**. Copy the generated Redirect URL. - Entra ID: ToolJet SAML Configuration + Entra ID: ToolJet SAML Configuration 5. Return to the Azure Developer Portal. Go to **Manage > Single sign-on**, edit **Basic SAML Configuration**, and paste the Redirect URL into both **Identifier (Entity ID)** and **Reply URL (Assertion Consumer Service URL)**. Click **Save**. - Entra ID: Azure SAML Configuration + Entra ID: Azure SAML Configuration 6. Edit **Attributes & Claims** and rename the **emailaddress** claim to **email**. Once these steps are completed, users should be able to sign in to ToolJet using Microsoft Entra ID via SAML without any additional configuration. - Sign-In Page + Sign-In Page ## Configure Group Sync using Microsoft Entra ID @@ -40,11 +40,11 @@ To configure, group sync with Microsoft Entra ID SAML, follow these steps: ``` 2. To obtain the Azure group Object ID, sign in to the Azure Developer Portal and navigate to Groups > All groups. Select the group you want to map and copy its Object ID. - Entra ID: Azure Group Object ID + Entra ID: Azure Group Object ID 3. In your ToolJet application, go to **Workspace settings > Workspace login > SAML** and enable **Group sync**. 4. In the Group attribute field, enter `groups`. - Entra ID: Enable Group Sync + Entra ID: Enable Group Sync Once configured, ToolJet will automatically sync user groups from Microsoft Entra ID based on the defined mappings. \ No newline at end of file diff --git a/docs/versioned_sidebars/version-3.16.0-LTS-sidebars.json b/docs/versioned_sidebars/version-3.16.0-LTS-sidebars.json index 251fded97f..08ae1a9ebe 100644 --- a/docs/versioned_sidebars/version-3.16.0-LTS-sidebars.json +++ b/docs/versioned_sidebars/version-3.16.0-LTS-sidebars.json @@ -711,8 +711,8 @@ "user-management/sso/oidc/okta", "user-management/sso/oidc/google", "user-management/sso/oidc/onelogin", - "user-management/sso/oidc/ssouserinfo", - "user-management/sso/oidc/auth0" + "user-management/sso/oidc/auth0", + "user-management/sso/oidc/ssouserinfo" ] }, "user-management/sso/ldap",