Setup Okta Single Sign-on with Drupal OAuth Client
Overview
Drupal miniOrange SSO integration will allow you to configure Single Sign-On ( SSO ) login between your Drupal site and Okta 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.
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 Okta(OAuth) 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, Okta.
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 Application in Okta
- Sign up for or log in to your Okta Developer account.
- 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 Configuration of Drupal with 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.
Note: Mapping the Email Attribute is mandatory for your login to work.
- Now log out and go to your Drupal site’s login page. You will automatically find a Login with Okta 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:
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]
Contact us
[MO_CONTACT_US]
