Get Free Trial
   

WordPress OAuth & OpenID Connect Single Sign-On (SSO) plugin enables secure login into WordPress using Zendesk as OAuth and OpenID Connect provider. You can also configure plugin using different custom providers and standard IDPs. It supports advanced Single Sign-On (SSO) features such as user profile Attribute mapping, Role mapping, etc. Here we will go through a guide to configure SSO between WordPress and Zendesk. By the end of this guide, users should be able to login to WordPress from Zendesk. To know more about other features we provide in WP OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin, you can click here.

Pre-requisites : Download And Installation

• Log into your WordPress instance as an admin.
• Go to the WordPress Dashboard -> Plugins and click on Add New.
• Search for a WordPress OAuth Single Sign-On (SSO) plugin and click on Install Now.
• Once installed click on Activate.

Steps to configure Zendesk Single Sign-On (SSO) Login into WordPress

1. Setup Zendesk as OAuth Provider

• First of all, 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.

• Click the OAuth Clients tab on the Channels/API page, and then click the plus icon (+) on the right side of the client list.

• Enter the name for your application under the Client Name field and add Callback/Redirect Url from miniOrange client plugin 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.
• After successful save, page refreshes with new pre-populated Client Secret field. Copy Unique Identifier and Client Secret and save it on your miniOrange Client plugin configuration.

You have successfully configured Zendesk as OAuth Provider for achieving Zendesk login into your WordPress Site.

2. Setup WordPress as OAuth Client

• Free
• Premium

• Go to Configure OAuth tab and click Add New Application to add a new client application into your website.

• Choose your Application from the list of OAuth / OpenID Connect Providers, Here Zendesk

• Copy the Callback URL to be used in OAuth Provider Configuration. Click Next.

• Configure App name & endpoints found from the Zendesk SSO application. Click Next.

Note: Once you create the Zendesk account, you'll find the Site Url and you will need to add the same in the below endpoints.




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/me.json


• Client Credentials like Client ID & Client Secret is shown in the setup dialogue box, read, write is already filled. click Next.

• Click on Finish to save the configuration.

• Go to Configure OAuth tab and search your application name to add a new client application into your website, Here Zendesk.

• Configure App Name, Client ID, Client Secret and endpoints from Zendesk SSO application.

Note: Once you create the Zendesk account, you'll find the Site Url and you will need to add the same in the below endpoints.




• Please refer the below table for configuring the scope & endpoints for Auth0 in the plugin.




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



• Choose your Grant Type from the list of options, hit Save and click on Test Configuration to test the setup.

You have successfully configured WordPress as OAuth Client for achieving user authentication with Zendesk Single Sign-On (SSO) login into your WordPress Site.

3. User Attribute Mapping

• User Attribute Mapping is mandatory for enabling users to successfully login into WordPress. We will be setting up user profile attributes for WordPress using below settings.

Finding user attributes

• Go to Configure OAuth tab. Scroll down and click on Test Configuration.

• You will see all the values returned by your OAuth Provider to WordPress in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.

• Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, you will get the list of attributes in a Username dropdown.

4. Role Mapping [Premium]

• Click on “Test Configuration” and you will get the list of Attribute Names and Attribute Values that are sent by your OAuth provider.
• From the Test Configuration window, map the Attribute Names in the Attribute Mapping section of the plugin. Refer to the screenshot for more details.

• Enable Role Mapping: To enable Role Mapping, you need to map Group Name Attribute. Select the attribute name from the list of attributes which returns the roles from your provider application.
  Eg: Role


• Assign WordPress role to the Provider role: Based on your provider application, you can allocate the WordPress role to your provider roles. It can be a student, teacher, administrator or any other depending on your application. Add the provider roles under Group Attribute Value and assign the required WordPress role in front of it under WordPress Role.
  
  For example, in the below image. Teacher has been assigned the role of Administrator & Student is assigned the role of Subscriber.

• Once you save the mapping, the provider role will be assigned the WordPress administrator role after SSO.
  Example: As per the given example, Users with role ‘teacher’ will be added as Administrator in WordPress and ‘student’ will be added as Subscriber.

5. Login Settings / Sign In Settings

• The settings in Single Sign-On (SSO) Settings tab define the user experience for Single Sign-On (SSO). To add a Zendesk login widget on your WordPress page, you need to follow the below steps.

Sign in settings for WordPress 5.7 and before

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.


Sign in settings for WordPress 5.8

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.

• Open your WordPress page and you can see the Zendesk SSO login button there. You can test the Zendesk Single Sign-On (SSO) now.

Sign in settings for WordPress 5.9

• Make sure the "Show on login page" option is enabled for your application. (Refer to the below image)

• Now, go to your WordPress Login page. (Eg. https://< your-wordpress-domain >/wp-login.php)
• You will see an Zendesk SSO login button there. Once you click the login button, you will be able to test the Zendesk Single Sign-On (SSO).

In this Guide, you have successfully configured Zendesk Single Sign-On (SSO) by configuring Zendesk as OAuth Provider and WordPress as OAuth Client using our WP OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin. This solution ensures that you are ready to roll out secure access to your WordPress site using Zendesk login credentials within minutes.

Additional Resources

• What is OAuth 2.0?
• Zendesk OAuth client documentation
• Frequently Asked Questions (FAQs)

Mail us on oauthsupport@xecurify.com for quick guidance(via email/meeting) on your requirement and our team will help you to select the best suitable solution/plan as per your requirement.