Back to Top

User Guide for Magento 2 Zoho SSO

Magento 2 Zoho SSO allows customers to sign in to Magento 2 using their Zoho account through a secure OAuth/OpenID Connect flow.

Instead of creating and remembering a separate Magento password, customers can log in with one Zoho account and access their store account faster.

If the customer email does not already exist in Magento, the module can automatically create the customer account and complete the login smoothly.

Store admin can configure Zoho Client ID, Client Secret, region, redirect URI, and default customer group directly from Magento backend.

This module is designed for Magento 2 store owners, administrators, and businesses using Zoho who want a simple, secure, and seamless single sign-on experience.

Features

  • Allow customers to sign in to Magento 2 using their Zoho account
  • Provide secure Zoho SSO through OAuth/OpenID Connect flow
  • Redirect users to Zoho login and return them to Magento after authentication
  • Automatically create Magento customer accounts if the Zoho email is new
  • Log existing customers into Magento when the email already exists
  • Protect the login flow with OAuth state validation
  • Support multiple Zoho regions such as US, EU, IN, AU, CN, and JP
  • Configure Zoho Client ID and Client Secret from Magento Admin
  • Display an auto-generated Authorized Redirect URI for Zoho Console setup
  • Allow optional custom redirect URI for special server setups
  • Set a default customer group for newly created customers
  • Show a Zoho login button on customer login and registration pages
  • Use custom logging for authentication, token exchange, and callback issues
  • Provide an admin configuration section under Webkul > Zoho SSO

Installation

Magento 2 Zoho SSO Extension installation is quite simple, just like the standard Magento 2 extensions.

#Download Module

Firstly, log in to the Webkul Store. Next, go to My Account > My Purchased Products and verify your purchase. After that, download the zip folder and extract its contents on your system.

#Upload Folder

Once the module zip extracts, follow the path src>app and copy the app folder into the Magento 2 root directory on the server as shown below:

installation upload folder

#Run Commands

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento indexer:reindex
php bin/magento cache:flush

Language Translation

For translating the module language, navigate through the app/code/Webkul/ZohoCrm /i18n and edit the en_US.csv file.

Thereafter, rename the CSV as “en_SA.csv” and translate all right-side content after the comma in the Arabic language. After editing the CSV, save it.

language translation

Now, upload it to the path app/code/Webkul/ZohoCrm /i18n where the installation of Magento 2 is on the server.

Additionally, Magento 2 Zoho SSO Integration Extension supports Arabic translation. Moreover, it is compatible with both RTL and LTR languages.

The user can edit the CSV like the image below.

Engage and hire Magento developers to solely concentrate on your personalized e-commerce projects for a unique experience

Configuration – Magento 2 Zoho SSO Integration

After installing the module, the admin can configure its settings. 

Next, Magento admin navigates to Stores > configuration > Webkul > Zoho SSO to access the settings page.

Magento 2 Zoho SSO extension  configuration settings
  • Enable Zoho SSO: show the Zoho login button on the frontend.
  • Zoho Data Center / Region: select the region where the app is registered.
  • Zoho Client ID: enter the Client ID from Zoho Developer Console.
  • Zoho Client Secret: enter the Client Secret from Zoho Developer Console.
  • Authorized Redirect URI: copy this callback URL into Zoho Console.
  • Custom Redirect URI: optional override for special setups.
  • Default Customer Group: assigned to newly created customers.

To get the Zoho API credentials, such as Client ID and Client Secret, click here to access the Zoho API Console.

Front End Workflow

Once the Magento 2 Zoho SSO Integration is configured, customers can securely sign in to the store using their Zoho account.

This extension redirects users through Zoho’s OAuth/OpenID Connect authentication flow and automatically returns them to Magento after successful verification.

Registration Page

Customers visiting the Magento registration page will find the Sign in with Zoho button.

New users can register and access their Magento account using their existing Zoho credentials, eliminating the need to create a separate store password.

registration page

Login Page

Returning customers can log in by clicking the Sign in with Zoho button available on the Magento login page.

This provides a faster and more convenient authentication method without requiring Magento-specific login credentials.

Zoho Authentication

After clicking Sign in with Zoho, customers are redirected to the Zoho authentication page.

They sign in using their Zoho account and, if prompted, grant the required permissions to continue the authentication process.

 Zoho sign in

Authorization and Callback

Once authentication is complete, Zoho redirects the customer back to the Magento store using the configured callback URL.

This extension validates the OAuth response, verifies the request, and securely exchanges the authorization code before completing the login process.

Successful Login

This extension checks whether the authenticated email address already exists in Magento.

Existing customers are logged in instantly, while new customers are automatically registered and signed in without any additional registration steps.

Magento 2 Zoho SSO extension successful customer login

Supports

If you have any questions or need assistance with the Magento 2 Zoho SSO Integration, feel free to contact the Webkul support team at [email protected].

Current Product Version - 4.0.0

Supported Framework Version - Magento 2.0.x, 2.1.x, 2.2.x,2.3.x, 2.4.x

. . .

Leave a Comment

Your email address will not be published. Required fields are marked*


Be the first to comment.

Back to Top

Message Sent!

If you have more details or questions, you can reply to the received confirmation email.

Back to Home
On this page

Table of Content

Back to top