Odoo is a powerful all in one management software, offering a range of business applications. It offers both community open source and enterprise versions with tools like including CRM, website/e-commerce, billing, accounting, manufacturing, warehouse - and project management, and inventory. Businesses can use this to manage their businesses and provide customized solutions to it's users.
Challenge faced by Odoo Users
If a user is logged into his site then he shouldn't have to log in second time to access services/resources on Odoo. A Single Sign-On (SSO) solution is required to allow users to be able to seamlessly move between their website and Odoo without the hassle of maintaining separate credentials. This allows admins to embed Odoo views on their site to give a unified experience to their users and customers.
miniOrange provides SSO solution for Odoo
miniOrange provides Single Sign-On solution to login to Odoo from your existing website using connectors or plugins. miniOrange supports JWT/OAuth/OpenID standard which is used to securely authenticate the user to login into applications like Odoo. A custom OAuth connector for Odoo enables SSO with any existing website.
Connect with External Source of Users
miniOrange provides user authentication from various external sources, which can be Directories (like ADFS, Microsoft Active Directory, OpenLDAP, AWS etc), Identity Providers (like Microsoft Entra ID, Okta, AWS), and many more. You can configure your existing directory/user store or add users in miniOrange.
Video Setup Guide
Prerequisites
Please make sure your organisation branding is already set under Customization >> Login and Registration Branding in the left menu of the dashboard.
Follow the Step-by-Step Guide given below for Odoo Single Sign-On (SSO)
Note
Please be advised that for the owner or administrator of a database within the Odoo, it is recommended to refrain from
utilizing OAuth authentication. Employing OAuth for this user role can result in the disassociation of the database from their respective
Odoo account. Consequently, the affected database would no longer be amenable to actions such as duplication, renaming, or other forms of management
through the Odoo portal.
Go to Apps and click Add Application button at right corner of your screen.
In Choose Application Type click on OAUTH/OIDC application type.
In the next step, search for your application from the list and select Odoo app.
Enter client information accordingly.
Attribute
Description
Client Name
Choose an appropriate name according to your choice
Redirect URL
<base-odoo-url>/auth_oauth/signin
Description
Description of your choice
Attributes
As shown in the image below
Scroll down and click on the “Save Button”.
Your Odoo application is Successfully configured with miniOrange.
You can edit Application by using the following steps:
Go to Apps >> Manage Apps.
Search for your app and Click on the edit in Action menu against your app.
Note down all the parameters (Client id,Client secret). You will need this info while configuring Odoo with miniOrange.
2. Configure SSO in Odoo Admin Account
Login to your Odoo account as administrator.
Create a new database if you don't already have one there.
After logging into Admin dashboard, go to settings.
Make sure that the Free Sign up option is enabled here.
Select Default access rights. Under the Oauth section, select you configured IDP as the oauth provider.
Enable Oauth Authentication and click on OAuth Providers to create a OAuth provider.
Create a new OAuth provider and name it as miniOrange.
Copy the client id authorization url , token endpoint, userinfo endpoint from the miniOrange.
Add token url in the Data endpoint field and enable the Allowed option.
Go to your Odoo base url page and you will find your created Oauth provider.
Click on miniOrange and your SSO flow will initiate.
Note - If you have existing users and want to change the OAuth handler, follow the bellow steps.
Go to Settings > Users > OAuth > OAuth provider and select Re-send Invitation Email.
After you click the link in the email, login with the new OAuth handler instead of using your old credentials.
If you do this correctly, you should see it populate the OAuth User ID and OAuth Access Token under Settings > User > OAuth
3. Configure Your User Directory
miniOrange provides user authentication from various external sources, which can be Directories (like ADFS, Microsoft Active Directory, Microsoft Entra ID, OpenLDAP, Google, AWS Cognito etc), Identity Providers (like Okta, Shibboleth, Ping, OneLogin, KeyCloak), Databases (like MySQL, Maria DB, PostgreSQL) and many more. You can configure your existing directory/user store or add users in miniOrange.
Here, fill the user details without the password and then click on the Create User button.
After successful user creation a notification message "An end user is added successfully" will be displayed at the top of the dashboard.
Click on Onboarding Status tab. Check the email, with the registered e-mail id and select action Send Activation Mail with Password Reset Link from Select Action dropdown list and then click on Apply button.
Now, Open your email id. Open the mail you get from miniOrange and then click on the link to set your account password.
On the next screen, enter the password and confirm password and then click on the Single Sign-On (SSO) reset password button.
Now, you can log in into miniOrange account by entering your credentials.
2. Bulk Upload Users in miniOrange via Uploading CSV File.
Navigate to Users >> User List. Click on Add User button.
In Bulk User Registration Download sample csv format from our console and edit this csv file according to the instructions.
To bulk upload users, choose the file make sure it is in comma separated .csv file format then click on Upload.
After uploading the csv file successfully, you will see a success message with a link.
Click on that link you will see list of users to send activation mail. Select users to send activation mail and click on Send Activation Mail. An activation mail will be sent to the selected users.
Click on External Directories >> Add Directory in the left menu of the dashboard.
Select Directory type as AD/LDAP.
STORE LDAP CONFIGURATION IN MINIORANGE: Choose this option if you want to keep your configuration in miniOrange. If active directory is behind a firewall, you will need to open the firewall to allow incoming requests to your AD.
STORE LDAP CONFIGURATION ON PREMISE: Choose this option if you want to keep your configuration in your premise and only allow access to AD inside premises. You will have to download and install miniOrange gateway in your premise.
Enter LDAP Display Name and LDAP Identifier name.
Select Directory Type as Active Directory.
Enter the LDAP Server URL or IP Address against LDAP Server URL field.
Click on Test Connection button to verify if you have made a successful connection with your LDAP server.
In Active Directory, go to the properties of user containers/OU's and search for Distinguished Name attribute.
Enter the valid Bind account Password.
Click on Test Bind Account Credentials button to verify your LDAP Bind credentials for LDAP connection.
Search Base is the location in the directory where the search for a user begins. You will get this from the same place you got your Distinguished name.
Select a suitable Search filter from the drop-down menu. If you use User in Single Group Filter or User in Multiple Group Filter, replace the <group-dn> in the search filter with the distinguished name of the group in which your users are present. To use custom Search Filter select "Write your Custom Filter" option and customize it accordingly.
You can also configure following options while setting up AD. Enable Activate LDAP in order to authenticate users from AD/LDAP. Click on the Save button to add user store.
Here's the list of the attributes and what it does when we enable it. You can enable/disable accordingly.
Attribute
Description
Activate LDAP
All user authentications will be done with LDAP credentials if you Activate it
Sync users in miniOrange
Users will be created in miniOrange after authentication with LDAP
Fallback Authentication
If LDAP credentials fail then user will be authenticated through miniOrange
Allow users to change password
This allows your users to change their password. It updates the new credentials in your LDAP server
Enable administrator login
On enabling this, your miniOrange Administrator login authenticates using your LDAP server
Show IdP to users
If you enable this option, this IdP will be visible to users
Send Configured Attributes
If you enable this option, then only the attributes configured below will be sent in attributes at the time of login
Click on Save. After this, it will show you the list of User stores. Click on Test Connection to check whether you have enter valid details. For that, it will ask for username and password.
On Successful connection with LDAP Server, a success message is shown.
Click on Test Attribute Mapping.
Enter a valid Username. Then, click on Test. Mapped Attributes corresponding to the user are fetched.
After successful Attribute Mapping Configuration, go back to the ldap configuration and enable Activate LDAP in order to authenticate users from AD/LDAP.
Go to Settings >> Product Settings in the Customer Admin Account.
Enable the "Enable User Auto Registration" option and click Save.
(Optional) To send a welcome email to all the end users that will be imported, enable the "Enable sending Welcome Emails after user registration" option and click Save.
From the Left-Side menu of the dashboard select Provisioning.
In Setup Provisioning tab select Active Directory in the Select Application drop-down.
Toggle the Import Users tab, click on Save button.
On the same section, switch to Import Users section.
Select Active Directory from the dropdown and click on the Import Users tab, to import all the users from Active Directory to miniOrange.
You can view all the Users you have imports by selecting Users >> User List from Left Panel.
All the imported users will be auto registered.
These groups will be helpful in adding multiple 2FA policies on the applications.
miniOrange integrates with various external user sources such as directories, identity providers, and etc.
Lets say you have configured miniOrange as your userstore.
On accessing the Single sign-On URL as mentioned in the second step, you will be asked for miniOrange credentials.
On entering the valid credentials, you will be successfully logged into Odoo.
Using IDP Initiated Login
Log into miniOrange IdP using your credentials.
On the End User-Dashboard, click on the Odoo application configured, to test the SSO flow.
You will be successfully logged into Odoo.
Using SP Initiated Login
Lets say you have configured Okta as IDP.
On accessing the Single sign-On URL as mentioned in the second step, you will be asked to enter your Okta credentials.
On entering the valid credentials, you will be successfully logged into Odoo.
Using IDP Initiated Login
Log into Okta using your credentials.
Click on Admin to access the Admin Console, then click on Applications.
Click on Add Application and search for "Bookmark App", and Click Add in the left pane.
Choose an app name of your choice which will be the display name.
In the URL section, enter the SSO URL that is given in the JWT app.
Click on Save.
On the End User-Dashboard, click on the Odoo bookmark application configured, to test the SSO flow.
You will be successfully logged into Odoo.
Embedded views :
If you enable the Default Option in the OAuth Settings and are not able to log into Odoo then use the following link to bypass SSO and log in using username and password instead:
<base-odoo-url>/web/login?sso=false
The embedded URL would look something like the following:
