Configure Consent Screen Feature in OAuth 2.1 Server

Overview

The Consent Screen allows users to review and approve the permissions requested by a client application before granting access. It helps users understand which information and resources the application is requesting access to, ensuring transparency and user control. This guide explains how to configure and customize the consent screen in the OAuth Server.

Download

Pricing Plans

Schedule a Meeting

Installation Steps

Using Composer
Using Drush
Manual Installation

Download the module:

composer require 'drupal/oauth_server_sso'
Go to Extend menu on your Drupal admin console and enable the module by enabling the checkbox and click on Install button.
Configure the module at:

{BaseURL}/admin/config/people/oauth_server_sso/config_client

Install the module:

drush en oauth_server_sso
Clear the cache:

drush cr
Configure the module at:

{BaseURL}/admin/config/people/oauth_server_sso/config_client

Navigate to Extend menu on your Drupal admin console and click on Install new module.
Install the Drupal OAuth / OIDC Provider - Single Sign On (SSO) 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.
Configure the module at:

{BaseURL}/admin/config/people/oauth_server_sso/config_client

Prerequisite

Before configuring the consent screen feature, ensure that the Drupal OAuth Server module is installed and configured on your Drupal site. Refer to this setup guide to complete the configuration.

Configuration Steps

After creating the client or registering the application, navigate to the App Registration tab.
From the left-side menu, click Client Settings.

Drupal OAuth Server - Click on Client Settings from left navigation menu

On the Client Settings tab, enable the Show consent screen for this client check box. It is a mandatory step.

Drupal OAuth Server - Enable Consent Screen

After that, navigate to the Consent Screen tab from the left side menu.

Drupal OAuth Server - Click Consent Screen from left navigation menu

On the consent screen tab, click the Preview consent screen button to preview the default consent screen.
To use a custom consent screen, enter the URL of your custom page in the Custom Consent Screen URL field. Users will be redirected to this URL instead of the built-in consent screen during authorization.
In the Remember Consent for (days) field, enter the number of days for which the user's consent should be remembered for this client application. Use -1 to follow the OAuth Server's default consent duration (30 days), or 0 to display the consent screen every time the user authorizes the application.
Finally, click the Save Client button to save the configuration.

Drupal OAuth Server - Enter Consent Screen Details and Click Save Client

That's it. You have successfully configured the Consent Screen.

Need Assistance?

If you face any issues during the configuration or if you want some additional features, please contact us at drupalsupport@xecurify.com.

Thank you for your response. We will get back to you soon.

Something went wrong. Please submit your query again

Contents

Configure Consent Screen Feature in OAuth 2.1 Server