AWS Cognito SSO Login into Drupal using OAuth / OpenID connect

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. This module is compatible with Drupal 7, Drupal 8, Drupal 9, Drupal 10, and Drupal 11. 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.

Playground Schedule a Meeting

Configuration Steps

Configure Drupal as an OAuth Client

• Go to Configuration → People → miniOrange OAuth Client Configuration in the Administration menu. (/admin/config/people/miniorange_oauth_client)

• Under the Configure OAuth tab select desired OAuth Provider from the dropdown.


Note: If the desired OAuth Provider is not listed in the dropdown, please select Custom OAuth Provider / Custom OpenID Provider and continue.

• Copy the Callback/Redirect URL and keep it handy. This will be required while configuring the OAuth Provider.


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.



• Enter the OAuth provider name in the Display Name text field.

Setup AWS Cognito as an OAuth Provider:

• Login to AWS console.
• Search for Cognito and click on it.

• 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.)

• Select the Provider types (keep it default if you are not sure) and the Cognito user pool sign-in options as per requirement.

• Select the appropriate options based on the need from the Password policy, Multi-factor authentication, User account recovery and click on Next button.

• Select the suitable options from the Configure sign-up experience as per requirements and click on the Next button.

• Choose the message delivery option. Click on the Next button.

• 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.

• Verify the information, scroll down and click on Create user pool button.
• Now search for the user pool you created and click on it.

• Now, lets create a user for the app.
• Click on Create user.

• Enter the user information like email and password and click on Create User button.

• Click on App integration.

• Under Domain section expand Actions and click on Create Cognito Domain.

• 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.

• Scroll down, find your app and click on it.

• Scroll down to Hosted UI. Click on Edit button.
• Click on Add callback URL button.

• Paste the copied Callback/Redirect URL into the URL text field.

• Click on Save button.
• Copy the Client ID and Client Secret.

Integrating Drupal with AWS Cognito:

• Go to miniOrange OAuth Client module.
• In Configure OAuth tab, paste the copied Client ID and Client Secret from AWS Cognito in the Client ID and Client Secret text-field.

• Replace the inital URL with the Cognito domain into the Authorize Endpoint and Access Token Endpoint textfields.

• 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.

Test Connection between Drupal and OAuth Provider

• After successfully saving the configurations, please click on the Perform Test Configuration button to test the connection between Drupal and OAuth Provider.

• On a Test Configuration popup, if you don't have any active sessions on the same browser, you will be requested to login to the OAuth Provider. After successfully logging, you will be provided a list of attributes received from the OAuth Provider.
• 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 to perform SSO i.e. login to the Drupal site with OAuth Provider credentials.

• On the Attribute & Role Mapping tab, please select the Username Attribute from the dropdown list 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 OAuth Provider link there. If you want to add the SSO link to other pages as well, 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:

• Attribute Mapping - map user's attributes received from OAuth Provider with Drupal fields
• Role mapping - assign a Drupal Role to users on the basis of their role/attribute on the OAuth provider
• Enable single logout - Logout user from the OAuth Provider (i.e. AWS Cognito, Azure AD B2C, Keycloak, Okta) when they logs out form Drupal
• Restrict anonymous access to the complete site or a particular section of the site
• Add Multiple OAuth Provides
• Explore All the features offered by the OAuth Client

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]

24/7 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.

 Contact us

Case Studies

miniOrange has successfully catered to the use cases of 400+ trusted customers with its highly flexible/customizable Drupal solutions.

 Read more

Other Solutions

Feel free to explore other Drupal solutions that we offer the popular solutions used by our trusted customers include 2FA, User Provisioning, Website Security.

 Know More