ToolJet/docs/versioned_docs/version-3.16.0-LTS/user-management/sso/oidc/onelogin.md

74 lines
5.2 KiB
Markdown
Raw Normal View History

2025-12-19 04:53:49 +00:00
---
id: onelogin
title: OneLogin
---
OneLogin can be configured as an identity provider (IdP) using OpenID Connect (OIDC), an authentication protocol that securely verifies user identities through a trusted provider. This document explains how to obtain the required credentials from the OneLogin Console. 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 OneLogin Admin Portal
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"/>
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"/>
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"/>
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, youll 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"/>
8. Go to ToolJet > Workspace settings > Workspace login > OpenID Connect > Add provider.
(Example URL - https://app.corp.com/demo-workspace/workspace-settings/workspace-login)
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"/>
2025-12-19 04:53:49 +00:00
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"/>
## Configuring Group Sync with OneLogin
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"/>
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"/>
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"/>
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"/>
6. Go to your ToolJet Application. Navigate to Workspace settings > Workspace login > OpenID Connect > Your OneLogin Configuration and Enable group sync.
7. Claim name will be set to `groups`.
8. Group mapping will be set as :
```js
<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"/>
Users will now be assigned to ToolJet groups based on their OneLogin roles.