Drupal Box Single Sign-on with OAuth Client
Overview
Drupal OAuth Client module enables Single Sign-On i.e. SSO for a Drupal site with
any Identity Provider using OAuth or OpenID connect protocol. Here we will go through the steps to configure the
module with the Box. Once this configuration is done, users will be able to log in to the Drupal site using
their Box credentials.
The integration of Drupal with Box simplifies and secures the login process, completely removing the
need to store, remember, and reset multiple passwords.
Installation Steps
- Using Composer
- Using Drush
- Manual Installation
Configuration Steps
Setup Drupal as OAuth Client:
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select Box from the Select Application dropdown list.
- Copy the Callback/Redirect URL and keep it handy. It will require to setup Box as OAuth provider.
- Enter the application name in the Display Name text field. For example, Box.
Note: If your provider only supports HTTPS Callback/Redirect URLs and you have an HTTP site, please make sure to enable the 'Enforce HTTPS Callback URL' checkbox at the bottom of the tab.
Setup Box as an OAuth Provider:
- Go to Box and 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.
- Scroll down to OAuth 2.0 Credentials​ section, you will get the Client ID and Client Secret. Copy them, you will need it to configure Drupal as OAuth Client.
- In the OAuth 2.0 Redirect URI​ section below, enter Redirect URI from Drupal field in miniOrange OAuth Client module. Click on Save Changes.
Integrating Drupal with Box:
- Go to miniOrange OAuth Client module.
- In Configure OAuth tab, Paste the copied Application (client) ID and Client Secret from Box into the Client ID and Client Secret text field
- Enter the Box details in the respective fields as per below table and click Save Configuration button.
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 |
Test Connection between Drupal and Box:
- After successfully saving the configurations, please click on the Test Configuration button to test the connection between Drupal and Box.
- This Test Configuration window will provide you with a list of the attributes that's received from the Box.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
Note: Mapping the Email Attribute is mandatory for your login to Box.
- Now, in the Attribute & Role Mapping tab, you can also choose the Username Attribute from the dropdown and click on the Save Configuration button.
- Now log out and go to your Drupal site’s login page. You will automatically find a Login with Box link there. If you want to add the SSO link to other pages as well, please follow the steps given in the image below:
Congratulations! You have successfully configured Box as OAuth/OpenID Provider and Drupal as an OAuth Client.
Need Assistance?
If you face any issues during the configuration or if you want some additional features, please contact us at drupalsupport@xecurify.com.
Additional Features:
Troubleshooting:
More FAQs ➔Getting error: 'Username not received. Check your Attribute Mapping configuration.' OR Getting Error: 'Email not received. Check your Attribute Mapping configuration.'
Follow the steps mentioned HERE
I am getting "Client Credentials were not found in
the headers or body"
when I try to perform test configuration
Follow the steps mentioned HERE
After I click on the logout in Drupal, it sends me back to the Drupal homepage. However, when I try to login with other user, it doesn't ask me to login but automatically logs me in with same user
The logout functionality you've mentioned here is the default behavior of a module. It's logging you out of Drupal but not from your Application/Provider. To allow the module to logout from your provider/application account (what you are looking for), you need to make the below configurations: [know more]
I purchased the paid Drupal module and replaced it with the free module, but still I am not able to use paid features.
As you have upgraded to one of our paid versions of the Drupal module and replaced the free module with the paid one, you must first activate the paid module. Please refer to the below steps. [Know more]