Configure Box Single Sign-On (SSO) with Joomla OAuth Client Plugin
Overview
Integration of Box Single Sign-on( Box SSO ) with Joomla using OAuth 2.0 Protocol. The miniOrange Joomla OAuth /
OpenID Connect Single SIgn-on (SSO) plugin makes it simple to set up Box SSO into Joomla and enable secure login
into Joomla. As a result, users can log in to Joomla and access the site by authenticating with their Box OAuth
Provider credentials.
Visit our Joomla OAuth Client Plugin webpage to learn more about
the features and plans we offer for the Joomla
OAuth Single Sign-on (OAuth & OpenID connect) plugin.
Configuration Steps
In this configuration, Box functions as the OAuth server, while Joomla allows users to log in with their Box credentials by utilizing the Joomla OAuth Client Plugin.
Step 1: Install Joomla OAuth Client Plugin
- Login into your Joomla site’s Administrator console.
- From left toggle menu, click on System, then under Install section click on Extensions.
- Now click on Or Browse for file button to locate and install the plugin file downloaded earlier.
- Installation of plugin is successful. Now click on Get Started!
- Under Configure OAuth -> Pre-Configured Apps tab, select your OAuth Provider. You can also search for custom OAuth or custom OpenID application in the search bar, and configure your own custom provider.
- After selecting your OAuth provider, you will be redirected to the Step 1 [Redirect URL] tab. Now copy the Callback/Redirect URL which we will use to configure Box as OAuth Server, then click on the Save & Next button.
Step 2: Configure Box as OAuth Server
- Login to your Box account. Click on the Create New App.
- Select Custom App and click on Next.
- Select Standard OAuth 2.0 (User Authentication) and click on Next.
- Enter Application Name and click on Create App.
- You will get a confirmation message. Click on View Your App.
- In the OAuth 2.0 Redirect URI section below, enter the Redirect URI. Click on Save Changes button.
Step 3: Configure Client ID & Secret
- Scroll down to OAuth 2.0 Credentials section, and copy the Client ID and Client Secret.
- Go back to your Joomla Dashboard. Then go to Step 2 [Client ID & Secret].
- Paste the Client ID, Client Secret and Domain. Also Set Client Credentials In header then click on Save Settings. Once Settings are saved then click on Save Configuration.
- Scope & Endpoints are given below, which are required for configuring Joomla as OAuth Client plugin to configure Box as a custom OAuth or OIDC provider.
Scope | root_readwrite |
Authorize Endpoint | https://account.box.com/api/oauth2/authorize |
Access Token Endpoint | https://api.box.com/oauth2/token |
Get User Info Endpoint | https://api.box.com/2.0/users/me |
Set Client Credentials | In Both (In Header and In Body) |
Step 4: Configure Attribute Mapping
- User Attribute Mapping is mandatory for enabling users to successfully login into Joomla. We will be setting up user profile attributes for Joomla using below settings.
- Go to Step 3 [Attribute Mapping] tab and click on Test Configuration button.
- You will be able to see the attributes in the Test Configuration output as follows.
- Now go to the Step 3 [Attribute Mapping] tab and Select the attribute name for Email and Username from dropdown. Then click on Finish Configuration button.
Step 5: Setup Login/SSO URL
- Now go to Step 4 [SSO URL] tab, here copy the Login/SSO URL and add it to your Site by following the given steps.
- Now logout and go to your Joomla site's pages where you have added this link. You will see a login link where you placed that button. Click on this button to perform SSO.