Single Sign On (SSO) login into Drupal using Okta as 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. Here we will go through the steps to configure the module with the Okta. Once this configuration is done, users will be able to log in to the Drupal site using their Okta credentials.

The integration of Drupal with Okta simplifies and secures the login process, completely removing the need to store, remember, and reset multiple passwords.

Setup Drupal as OAuth Client:

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

  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 application name in the Display Name text field. For example, Okta

Create SSO Application in Okta:

• Sign up for or log in to your Okta Developer account.
• Switch to Classic UI to configure app.

• From the left side navigation panel, click on Applications -> then select Applications.

• Under Application, click on Create App Inetgration button to create new application.

• After clicking on Create App Integration button, Open a popup window Create a new App Integration as below image:
• In the Sign-in method: Select OIDC-OpenID Connect.
• Application type: Select Web Application.
• Click the Next button.

• Enter the following information in the New Web App Integration panel:
• Enter the name of application in App integration name text field under General Settings. Drupal, for example.
• Paste the previously copied Callback/Redirect URL into the Sign-in redirect URIs text field.
• Assignments: Select Allow everyone in your organization to access from the Controlled access option, and unchecked the Enable immediate access with Federation Broker Mode. When you've finished configuring, click on the Save button.

Integrating Drupal with Okta:

• Okta assigns a unique Application ID to your application. Navigate to the General tab.
• Click on the copy Icon to copy the Client ID from Client Credentials.

• In Drupal’s Configure OAuth tab paste the copied Client ID into the Client ID text field.

• Navigate to the Okta portal's General tab.
• Copy the Secret by clicking the copy Icon in the CLIENT SECRETS section.

• In Drupal’s Configure OAuth tab paste the copied Secret into the Client Secret text field.

How to find your Okta URL/Domain:

• Go to the Okta Dashboard.
• Navigate to the Profile Icon in the upper right navigation panel and click on it.

• Now, navigate to the Drupal site and replace the Okta Domain with {yourOktaDomain} in the Authorize Endpoint, Access Token Endpoint, and Get User Info Endpoint text fields that you previously copied. Click the Save Configuration button.


You can refer to the Okta Endpoints and Scope from the table given below:

Scope	openid email profile
Authorize Endpoint	https://{yourOktaDomain}.com/oauth2/default/v1/authorize
Access Token Endpoint	https://{yourOktaDomain}.com/oauth2/default/v1/token
Get User Info Endpoint	https://{yourOktaDomain}.com/oauth2/default/v1/userinfo

Test connection between Drupal and Okta:

• Click on the Perform Test Configuration button to test the connection between Drupal and Okta.

• On a Test Configuration popup, if you don't have any active sessions on the same browser, you will be requested to login into the Okta. After successfully logging into the Okta, you will be provided a list of attributes received from the Okta.
• Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.

• In the Attribute & Role Mapping tab, you can also choose the Username Attribute from the dropdown and click on the Save Configuration button.

Please note: Mapping the Email Attribute is mandatory for Single Sign-On.

Congratulations! You have successfully configured Okta 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 Okta 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: