Setup Coil Single Sign-on with Drupal OAuth Client
Overview
Drupal Coil SSO integration will allow you to configure Single Sign-On ( SSO ) login between your Drupal site
and Coil using OAuth/OpenID protocol. Drupal OAuth 2.0/OpenID connect module
gives the ability to enable login using OAuth 2.0/OIDC Single Sign-On to Drupal Site.
We provide the Drupal OAuth/OpenID Client module for Drupal 7, Drupal 8, Drupal 9 and Drupal 10, Drupal 11.
Here we will go through a guide to configure the SSO login between Drupal and Coil. By following these steps,
users of Coil will be able to log into the Drupal site using their Coil credentials.
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 Custom OAuth 2.0 Provider from the Select Application dropdown list.
- Copy the Callback/Redirect URL and keep it handy.
- Enter the application name in the Display Name text field. For example, Coil.
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.
Create SSO Application in Coil
- Sign up for a free Coil account if you don't already have one.
- Create an SSO application in Coil and upload the copied Callback/Redirect URL to it.
Integrating Drupal with Coil
- Copy the Client ID and the Client secret and keep it handy.
- Coil Endpoints and Scope:
Scope: | simple_wm openid email |
Authorize Endpoint: | https://coil.com/oauth/auth |
Access Token Endpoint: | https://coil.com/oauth/token |
Get User Info Endpoint: | https://api.coil.com/user/info |
- In Drupal’s Configure OAuth tab and paste the copied Client ID and Client Secret (copied from the Coil) in the Client ID and Client Secret text-field.
Test Configuration of Drupal with Coil
- Click on the Perform Test Configuration button to test the connection.
- On a Test Configuration popup, if you don't have an active session in Coil on the same browser, you'll be prompted to sign in to Coil. Once successfully logged in, you'll receive a list of attributes retrieved from Coil.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
- Once clicked on Done button, you will be redirected to the Attribute & Role Mapping tab, in which you can select the Username Attribute from the dropdown list and click on Save Configuration button
Note: Mapping the Email Attribute is mandatory for your login to work.
How to perform the SSO
- Open a new browser/private window and navigate to the Drupal site login page.
- Click on the Login using Coil link to initiate the SSO from Drupal.
- If you want to add the SSO link on other pages, please follow the steps given in the image below:
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]
[MO_CONTACT_US]