mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-21 13:37:28 +00:00
[docs]: Updated img classes and sidebar order
This commit is contained in:
Aditya Joshi
parent
776cb46ad6
commit
74fbc77f49
5 changed files with 31 additions and 61 deletions
|
|
@ -10,18 +10,18 @@ To setup OIDC using Auth0, you can follow these steps:
|
|||
|
||||
1. Go to <a href="https://manage.auth0.com/dashboard" target="_blank">Auth0 Dashboard</a>, navigate to the **Applications** section and click on _Create Application_.
|
||||
|
||||
<img className="screenshot-full" src="/img/user-management/sso/oidc/auth0/create-app.png" alt="Auth0: SSO"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/oidc/auth0/create-app.png" alt="Auth0: SSO"/>
|
||||
|
||||
2. Select **Regular Web Applications**. You can keep other settings unchanged and click on _Create_.
|
||||
<img className="screenshot-full img-m" src="/img/user-management/sso/oidc/auth0/application-type.png" alt="Auth0: SSO"/>
|
||||
|
||||
3. Go to **Settings** to get the **Client ID**, **Client Secret** and **Domain**.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/oidc/auth0/auth0-OIDC-configuration.png" alt="Auth0: ToolJet Configuration"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/oidc/auth0/auth0-OIDC-configuration.png" alt="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)
|
||||
|
||||
<img className="screenshot-full" src="/img/user-management/sso/oidc/auth0/enableOIDC.png" alt="Auth0: ToolJet Configuration"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/oidc/auth0/enableOIDC.png" alt="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 `<YOUR-AUTH0-DOMAIN>` 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.
|
||||
<img className="screenshot-full " src="/img/user-management/sso/oidc/auth0/sign_in_page.png" alt="Sign-In Page"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/oidc/auth0/sign_in_page.png" alt="Sign-In Page"/>
|
||||
|
|
@ -3,36 +3,6 @@ id: azuread
|
|||
title: Microsoft Entra ID
|
||||
---
|
||||
|
||||
<!-- # AzureAD Single Sign-on
|
||||
|
||||
:::info
|
||||
To construct a Well Known URL refer this link :: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc
|
||||
:::
|
||||
|
||||
- Open your organization page and select `App registration`, and then select `New registration`.
|
||||
<img className="screenshot-full" src="/img/sso/azuread/azure-app-reg-v2.gif" alt="Azure AD: SSO" />
|
||||
|
||||
- Enter name, select supported account type and enter the redirect URL which can be copied from `Manage SSO -> Open Id -> Redirect URL, click on register`.
|
||||
<img className="screenshot-full" src="/img/sso/azuread/azure-3.png" alt="Azure AD: SSO" />
|
||||
|
||||
- Application will be registered and will be able to view the details
|
||||
|
||||
- Configure Application (Client) ID as `client id` in Open Id configuration page.
|
||||
<img className="screenshot-full" src="/img/sso/azuread/azure-4-cred.png" alt="Azure AD: SSO"/>
|
||||
|
||||
- Click on `Add certificate or secret` next to the **Client credentials**.
|
||||
|
||||
- Click on `+ New Client Secret`
|
||||
<img className="screenshot-full" src="/img/sso/azuread/azure8.png" alt="Azure AD: SSO" />
|
||||
|
||||
- Give a description, set the expiry, and then click on the `Add` button.
|
||||
<img className="screenshot-full" src="/img/sso/azuread/azure7.png" alt="Azure AD: SSO" />
|
||||
|
||||
- Secret will be created, copy value and add it to the `client secret` section of Open Id SSO config.
|
||||
|
||||
- You can brand the redirect page using the branding and properties option.
|
||||
<img className="screenshot-full" src="/img/sso/azuread/azure9.png" alt="Azure AD: SSO" /> -->
|
||||
|
||||
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**.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/oidc/microsoft-entra-id/app-registration.png" alt="App registration" />
|
||||
<img className="screenshot-full img-l" src="/img/user-management/sso/oidc/microsoft-entra-id/app-registration.png" alt="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**.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/oidc/microsoft-entra-id/register-application.png" alt="Register application" />
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/oidc/microsoft-entra-id/register-application.png" alt="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.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/oidc/microsoft-entra-id/client-secret.png" alt="Client secret" />
|
||||
<img className="screenshot-full img-l" src="/img/user-management/sso/oidc/microsoft-entra-id/client-secret.png" alt="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.
|
||||
<img className="screenshot-full " src="/img/user-management/sso/oidc/microsoft-entra-id/sign_in_page.png" alt="Sign-In Page"/>
|
||||
<img className="screenshot-full img-l" src="/img/user-management/sso/oidc/microsoft-entra-id/sign_in_page.png" alt="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.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/oidc/microsoft-entra-id/group-sync/token-configuration.png" alt="Token Configuration" />
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/oidc/microsoft-entra-id/group-sync/token-configuration.png" alt="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.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/oidc/microsoft-entra-id/group-sync/groups-claim.png" alt="Groups Claim" />
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/oidc/microsoft-entra-id/group-sync/groups-claim.png" alt="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.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/oidc/microsoft-entra-id/group-sync/group-id.png" alt="Groups Object ID" />
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/oidc/microsoft-entra-id/group-sync/group-id.png" alt="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
|
||||
```
|
||||
<img className="screenshot- border-none" src="/img/user-management/sso/oidc/microsoft-entra-id/group-sync/group-sync-configuration.png" alt="Group Sync COnfiguration" />
|
||||
<img className="screenshot-full border-none img-full" src="/img/user-management/sso/oidc/microsoft-entra-id/group-sync/group-sync-configuration.png" alt="Group Sync COnfiguration" />
|
||||
|
|
@ -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**.
|
||||
<img className="screenshot-full border-none" src="/img/user-management/sso/oidc/onelogin/add_application.png" alt="OneLogin: Add Application"/>
|
||||
<img className="screenshot-full border-none img-l" src="/img/user-management/sso/oidc/onelogin/add_application.png" alt="OneLogin: Add Application"/>
|
||||
|
||||
3. In the Find Applications page, search for OpenID Connect (OIDC) and Select OpenId Connect (OIDC).
|
||||
<img className="screenshot-full border-none" src="/img/user-management/sso/oidc/onelogin/find_application.png" alt="OneLogin: Find Application"/>
|
||||
<img className="screenshot-full border-none img-l" src="/img/user-management/sso/oidc/onelogin/find_application.png" alt="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.
|
||||
<img className="screenshot-full border-none" src="/img/user-management/sso/oidc/onelogin/assign_application_1.png" alt="OneLogin: Assign Application to User"/>
|
||||
<img className="screenshot-full border-none img-l" src="/img/user-management/sso/oidc/onelogin/assign_application_1.png" alt="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.
|
||||
<img className="screenshot-full border-none" src="/img/user-management/sso/oidc/onelogin/onelogin_configuration.png" alt="OneLogin: Configuration"/>
|
||||
<img className="screenshot-full border-none img-l" src="/img/user-management/sso/oidc/onelogin/onelogin_configuration.png" alt="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**.
|
||||
<img className="screenshot-full border-none" src="/img/user-management/sso/oidc/onelogin/redirect_url.png" alt="OneLogin: Redirect URL"/>
|
||||
<img className="screenshot-full border-none img-l" src="/img/user-management/sso/oidc/onelogin/redirect_url.png" alt="OneLogin: Redirect URL"/>
|
||||
|
||||
You shall now be able to login to your ToolJet workspace using OneLogin.
|
||||
<img className="screenshot-full " src="/img/user-management/sso/oidc/onelogin/sign_in_page.png" alt="Sign-In Page"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/oidc/onelogin/sign_in_page.png" alt="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.
|
||||
<img className="screenshot-full border-none" src="/img/user-management/sso/oidc/onelogin/add_app_to_role.png" alt="OneLogin: Add Application To Role"/>
|
||||
<img className="screenshot-full border-none img-l" src="/img/user-management/sso/oidc/onelogin/add_app_to_role.png" alt="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.
|
||||
<img className="screenshot-full border-none" src="/img/user-management/sso/oidc/onelogin/add_user_to_role.png" alt="OneLogin: Add User To Role"/>
|
||||
<img className="screenshot-full border-none img-l" src="/img/user-management/sso/oidc/onelogin/add_user_to_role.png" alt="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)<br /><br />
|
||||
|
||||
<img className="screenshot-full border-none" src="/img/user-management/sso/oidc/onelogin/edit_field_groups.png" alt="OneLogin: Edit Field Groups"/>
|
||||
<img className="screenshot-full border-none img-full" src="/img/user-management/sso/oidc/onelogin/edit_field_groups.png" alt="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 > .*`
|
||||
<img className="screenshot-full border-none" src="/img/user-management/sso/oidc/onelogin/one_login_rule.png" alt="OneLogin: One Login Rule"/>
|
||||
<img className="screenshot-full border-none img-full" src="/img/user-management/sso/oidc/onelogin/one_login_rule.png" alt="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:
|
|||
<your-onelogin-role> -> <tooljet-group-name>
|
||||
```
|
||||
For example: If your OneLogin Role is **builder** and the ToolJet group name is **developer**, the mapping will be builder -> developer.
|
||||
<img className="screenshot-full border-none" src="/img/user-management/sso/oidc/onelogin/tooljet_configuration.png" alt="OneLogin: ToolJet Configuration"/>
|
||||
<img className="screenshot-full border-none img-full" src="/img/user-management/sso/oidc/onelogin/tooljet_configuration.png" alt="OneLogin: ToolJet Configuration"/>
|
||||
|
||||
Users will now be assigned to ToolJet groups based on their OneLogin roles.
|
||||
|
|
@ -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**.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/saml/entra-id/add_application.png" alt="Entra ID: Create Application"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/saml/entra-id/add_application.png" alt="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.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/saml/entra-id/tooljet_saml_configuration.png" alt="Entra ID: ToolJet SAML Configuration"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/saml/entra-id/tooljet_saml_configuration.png" alt="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**.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/saml/entra-id/azure_saml_configuration.png" alt="Entra ID: Azure SAML Configuration"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/saml/entra-id/azure_saml_configuration.png" alt="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.
|
||||
|
||||
<img className="screenshot-full " src="/img/user-management/sso/saml/entra-id/sign_in_page.png" alt="Sign-In Page"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/saml/entra-id/sign_in_page.png" alt="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.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/saml/entra-id/group_object_id.png" alt="Entra ID: Azure Group Object ID"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/saml/entra-id/group_object_id.png" alt="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`.
|
||||
<img className="screenshot-full" src="/img/user-management/sso/saml/entra-id/enable_group_sync.png" alt="Entra ID: Enable Group Sync"/>
|
||||
<img className="screenshot-full img-full" src="/img/user-management/sso/saml/entra-id/enable_group_sync.png" alt="Entra ID: Enable Group Sync"/>
|
||||
|
||||
Once configured, ToolJet will automatically sync user groups from Microsoft Entra ID based on the defined mappings.
|
||||
|
|
@ -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",
|
||||
|
|
|
|||
Loading…
Reference in a new issue