Configure Zendesk as an OAuth/OpenId Connect Server in Joomla

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

Step 1: Install OAuth Client plugin. (If you have already installed the plugin, you can skip to step 2)

  • Download the zip file of the miniOrange OAuth Client plugin for Joomla from the link here.
  • Joomla OAuth Client Plugin - Download
  • Login into your Joomla site’s administrator console.
  • Go to Extension Manage Install in the top navigation bar to install the plugin.
  • Joomla OAuth Client Plugin - Install
  • Upload the downloaded zip file to install the OAuth Client plugin.
  • Joomla OAuth Client Plugin - Upload

Step 2: miniOrange Joomla OAuth Client plugin - Callback URL

  • Go to Components miniOrange OAuth Client in the top navigation bar to go to the configuration page of the plugin.
  • Joomla OAuth Client Plugin - Component
  • In the Configure OAuth tab, select your OAuth/OpenID Connect provider. If your OAuth/OpenID Connect provider is not listed, you can select Custom OAuth/OpenID Connect provider to continue.
  • Joomla OAuth Client Plugin - Configure OAuth
  • Copy the Redirect/Callback URL given in the plugin and keep it handy because you will need it in the next step.
  • Joomla OAuth Client - Test Configuration

Step 3: Configure Zendesk 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 which you copied in the last step 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
    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 4: Configure miniOrange Joomla OAuth Client plugin.

  • Paste the Client ID and Client Secret which you copied in the last step and save it in the respective fields and then click on the Test Configuration button.
  • Joomla OAuth Client - Test Configuration
  • Now copy the email and name attributes you got in the test configuration and save these attributes in Email Attribute and Username Attribute text field respectively. Now click on the Save Attribute Mapping button to save your configurations.
  • Joomla OAuth Client - Attribute Mapping
  • You would find appropriate URL for performing the SSO after selecting the OAuth/OpenID Connect provider in the Login URL field (After completing test configuration please copy the Login URL and Add a button on your site login page).
  • Joomla OAuth Client - Login URL
  • Now logout and go to your Joomla site's pages where you have added this link. You will see a login link where you placed that button.
  • Congratulations, you have successfully configured the miniOrange OAuth Client plugin with your desired OAuth Provider.
  • Click on the Upgrade Plans tab to check out our complete list of features and various licensing plans.
  • If you want to purchase any of the paid version of the plugin, you have to register/login with us in Account Setup tab.
  • In case, you are facing some issue or have any question in mind, you can reach out to us by sending us your query through the Support button in the plugin or by sending us a mail at joomlasupport@xecurify.com.

Free Trial

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