Setup Guide to Configure Zendesk with Drupal

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.
  • Keycloak add realm
  • Click the OAuth Clients tab in the Channels/API page, and then click the plus icon (+) on the right side of the client list.
  • Add Role
  • 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.
  • Add User
  • 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.
  • Credentials

Step 2: Configure miniOrange Drupal Oauth Client module.

  • Login in your Drupal site’s admin console and click on Extend/Module from the top navigation bar.
  • Select the Install new module option to install a new module on your Drupal site.
  • Install New Module
  • Upload the downloaded zip file of the Module and click on the Install button to continue.
  • Click on Extend/Modules from the top navigation bar again and 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.
  • Miniorange OAuth install
  • Now click on Configuration in Drupal dashboard then click on Drupal OAuth Client Configuration.
  • Drupal OAuth Configuration
  • In Configure OAuth Application:

    1. Select application from dropdown list.
    2. Copy the CallBack/Redirect URL and save it on your OAuth Provider.
    3. Fill in the following details:

      1. Custom app name
      2. Display Name
      3. Client ID which is application ID from Step 1.
      4. Client Secret which is key value from step 1.
      5. Scope
      6. Authorize Endpoint
      7. Access Token Endpoint
      8. Get User Info Endpoint
    4. Then click on save configuration
    5. Now click on the Test Configuration button. 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 Configuration button to save your attribute configurations.
  • Save Configuration
  • Now logout and go to your Drupal 8 site’s login page, you will automatically find a Login with there. If you want to add your login link to other pages as well, please follow the steps given in the below image:
  • Instructions to add login link to different pages
  • If you want to check out our complete list of features and our various licensing plans, you can go to the Upgrade Plans tab in the module.
  • Congratulations, you have successfully configured the miniOrange Drupal OAuth Client module.
    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

Free Trial

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