Setup Guide to Configure Zendesk with Drupal

miniOrange Drupal OAuth/OpenID module gives the ability to enable OAuth/OpenID Single Sign On for Drupal site. Drupal OAuth Client module is compatible with all OAuth/OpenID Providers. Here we will go through a guide to configure SSO between Drupal and Zendesk. By the end of this guide, Zendesk users should be able to login and register to Drupal site.
If you have any doubts or queries you can contact us at drupalsupport@xecurify.com. We will help you to configure the module.

Step 1: Configure Zendesk as an OAuth server

  • Go to https://www.zendesk.com/login/ and sign up/login.
  • In Zendesk support click on Admin and select the API in the Channels category.
  • Zendesk API Settings
  • Click the OAuth Clients tab in the Channels/API page, and then click the plus icon (+) on the right side of the client list.
  • Zendesk Create Client
  • Enter a name for your application under the Client Name field and add Callback/Redirect URL from miniOrange OAuth Client module under Redirect URLs field. The Unique Identifier field is auto-populated with a reformatted version of the name you entered for your app. You can change it if you want. Click on Save to create a new OAuth client.
  • Zendesk OAuth App Setup
  • After successful save, page refreshes with new pre-populated Client Secret field. Copy Unique Identifier and Client Secret, you’ll need them in the next step.
  • Zendesk Client Secret
    Scope: read write
    Authorize EndPoint: https://{subdomain}.zendesk.com/oauth/authorizations/new
    Access Token Endpoint: https://{subdomain}.zendesk.com/oauth/tokens
    Get User Info Endpoint: https://{subdomain}.zendesk.com/api/v2/users

Step 2: Configure miniOrange Drupal OAuth Client module.

  • Login in your Drupal site’s admin console and click on Extend from the top navigation bar.
  • Select the Install new module option to install a new module on your Drupal site.
  • Drupal OAuth Client module - Install
  • Upload the downloaded zip file of the Module and click on the Install button to continue.
  • Drupal OAuth Client module - Upload
  • Select Enable newly added modules.
  • Drupal OAuth Client module - Update manager
  • Scroll down till you find miniOrange OAuth Client. Click on the checkbox next to it and click on the Install button to enable the module.
  • Drupal OAuth Client module - Enable module
  • Click on Configuration from the top navigation bar and Select Drupal OAuth client Configuration.
  • Drupal OAuth Client - Configuration
  • Click on the Configure OAuth Client tab and select your OAuth Provider from the Select Application dropdown. In case you do not find your OAuth Provider listed in the dropdown, please select Custom OAuth Provider and continue.
  • Drupal OAuth Client - Configure module
  • Enter your OAuth Provider information in their respective fields and click on the Save button to continue. Also, copy the Callback/Redirect URL and save it on your OAuth Provider.
  • Drupal OAuth Client - Configure OAuth tab
  • Now click on the Test Configuration option. This Test Configuration link will give you the list of the attributes that are coming from your OAuth Provider.
  • Copy the email and the name attributes and save them under the Attribute & Role Mapping tab in the Email Attribute and Name Attribute text field respectively.
  • Please note: This step is mandatory for your login to work. Click on the Save button on the bottom of the page to save your attribute configurations.

    Drupal OAuth Client Attribute Mapping
  • If your OAuth Provider supports only HTTPS Root URL or Base URL (for eg. Azure, Azure B2C) you can change it under Sign In Settings tab.
  • Drupal OAuth Client Redirect URL
  • Now logout and go to your Drupal site’s login page, you will automatically find a Login withYour OAuth Provider link there. If you want to add your login link to other pages as well, please follow the steps given in the below image:
  • Drupal OAuth Client login link
  • If you want to check out our complete list of features and our various licensing plans, you can go to the Upgrade Plan tab in the module.
  • If you want to purchase any of the paid version of the module, you have to register/login with us in Register/Login tab.
  • Still, if you are facing any difficulty or if you have any questions in mind, you can reach out to us by submitting a query in the Support tab of a module or by sending us a mail at info@xecurify.com.
  • Congratulations, you have successfully configured the miniOrange Drupal OAuth Client module.

Free Trial

If you are looking for anything which you cannot find, please drop us an email on info@xecurify.com