Search Results :

×

AWS Cognito SSO Login into Drupal using OAuth / OpenID connect


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. This module is compatible with Drupal 7, Drupal 8, Drupal 9, and Drupal 10. Here we will go through the steps to configure the module with the AWS Cognito. Once this configuration is done, users will be able to log in to the Drupal site using their AWS credentials.

Installation Steps:


  • Download the module:
    composer require 'drupal/miniorange_oauth_client'
  • Navigate to Extend menu on your Drupal admin console and search for miniOrange OAuth Client Configuration using the search box.
  • Enable the module by checking the checkbox and click on the Install button.
  • You can configure the module at:
    {BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
  • Install the module:
    drush en drupal/miniorange_oauth_client
  • Clear the cache:
     drush cr
  • You can configure the module at:
    {BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
  • Navigate to Extend menu on your Drupal admin console and click on Install new module.
  • Install the Drupal OAuth & OpenID Connect Login - OAuth2 Client SSO Login module either by downloading the zip or from the URL of the package (tar/zip).
  • Click on Enable newly added modules.
  • Enable this module by checking the checkbox and click on install button.
  • You can configure the module at:
    {BaseURL}/admin/config/people/miniorange_oauth_client/config_clc

Setup Drupal as OAuth Client:

  • After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select AWS Cognito from the Select Application dropdown list.
  • Drupal OAuth Client - Select AWS Cognito from Select Application dropdown
  • Copy the Callback/Redirect URL and keep it handy.

    Note:- If you have an HTTP Drupal site, and AWS Cognito enforces the HTTPS Redirect URI. Please navigate to the Sign In Settings tab of the module and set the base URL of the site with HTTPS in the Base URL text field.

  • Enter the name in the Custom App Name text field. For example, AWS Cognito
  • Drupal OAuth Client - Configure OAuth - Copy the Callback URL

Setup AWS Cognito as an OAuth Provider:

  • Login to AWS console.
  • Search for Cognito and click on it.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Login AWS Console
  • Click on Create user pool button to create new user pools. (User Pool is a user directory. Users in User Pool can access the app using AWS Cognito credentials.)
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Manage Pool
  • Select the Provider types (keep it default if you are not sure) and the Cognito user pool sign-in options as per requirement.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Create Pool
  • Select the appropriate options based on the need from the Password policy, Multi-factor authentication, User account recovery and click on Next button.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO User Pool
  • Select the suitable options from the Configure sign-up experience as per requirements and click on the Next button.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Add App Client
  • Choose the message delivery option. Click on the Next button.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Create App Client
  • Enter the User Pool name. Under the Initial app client select the Confidential client radio button. Enter the App client name. Click on the Next button.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Create App Client
  • Verify the information, scroll down and click on Create user pool button.
  • Now search for the user pool you created and click on it.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Create App Client
  • Now, lets create a user for the app.
  • Click on Create user.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Create App Client
  • Enter the user information like email and password and click on Create User button.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Allowe Scopes OAuth Flows
  • Click on App integration.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Allowe Scopes OAuth Flows
  • Under Domain section expand Actions and click on Create Cognito Domain.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO App Client ID
  • Enter the domain name and click on Create Cognito Domain. Copy the Cognito domain it will be required later for Authorization and Access Token endpoints.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Domain Name
  • Scroll down, find your app and click on it.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Domain Name
  • Scroll down to Hosted UI. Click on Edit button.
  • Click on Add callback URL button.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Create User
  • Paste the copied Callback/Redirect URL into the URL text field.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO Create User
  • Click on Save button.
  • Copy the Client ID and Client Secret.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) AWS Cognito SSO User and Groups

Integrating Drupal with AWS Cognito:

  • Go to miniOrange OAuth Client module. Paste the copied Client ID and Client Secret into the respective field.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) - paste the copied ID and Secret into the corresponding-text-fields
  • Replace the inital URL with the Cognito domain into the Authorize Endpoint and Access Token Endpoint textfields.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) - Replace the intial URL with Cognito domain into the Endpoints fields
  • The 'Send Client ID and Secret in Header or Body' checkbox allows you to specify whether the Client ID and Secret should be included in the header or the body of the Token Endpoint Request. If you're unsure which option to select, you can stick with the default settings.
  • Click on the checkbox to Enable Login with OAuth, scroll down, and click the Save Configuration button.
  • Drupal OAuth OpenID OIDC Single Sign On (SSO) Enabling the Login with OAuth checkbox and click Save Configuration

Test Connection between Drupal and AWS Cognito:

  • Click on the Perform Test Configuration button.
  • Drupal OAuth OpenID Single Single On Click on Perform Test Configuration button to check the SSO Connection
  • On a Test Configuration popup, if you don't have an active session in AWS Cognito on the same browser, you'll be prompted to sign in to AWS Cognito. Once successfully logged in, you'll receive a list of attributes retrieved from AWS Cognito.
  • Drupal OAuth OpenID Single Single On - Received the list of Attribute from Aws Cognito
  • Scroll down and click on the Configure Attribute / Role Mapping button.
  • On the Attribute & Role Mapping tab, please select the attribute under which the email of the user is received from the Email Address drop-down menu. Similarly, you can select the suitable option from the Name Attribute drop-down menu.
  • Drupal OAuth OpenID Single Single On - Under Attribute & Role Mapping tab, select the Email Attribute

Please note: Mapping the Email Attribute is mandatory for Login.

Congratulations! You have successfully configured AWS Cognito as OAuth/OpenID Provider and Drupal as an OAuth Client.

How to perform the SSO?

  • Now, open a new browser/private window and go to your Drupal site login page.
  • Click on the Login using the AWS Cognito link to initiate the SSO from Drupal.
  • If you want to add the SSO link to other pages as well, please follow the steps given in the image below:
  • Drupal OAuth OpenID Single Single-On - Add login link into different page of the Drupal site

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:

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]

Frequently Asked Questions (FAQ)
 

[Know more]

 Case Studies
miniOrange has successfully catered to the use cases of 400+ trusted customers with its highly flexible/customizable Drupal solutions. Feel free to check out some of our unique case studies using this link.
 Other Solutions
Feel free to explore other Drupal solutions that we offer here. The popular solutions used by our trusted customers include Two Factor Authentication - 2FA, Website Security, REST & JSON API Authentication, User Provisioning and Sync. 
  24*7 Active Support
The Drupal developers at miniOrange offer quick and active support for your queries. We can assist you from choosing the best solution for your use case to deploying and maintaining the solution.
Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com