Make the shift to Zoho OAuth
In this article, you will learn about making the shift from Authtokens to Zoho OAuthtokens—a revamped version of the security token you currently use.
Direct API Calls
If you've created apps that make direct API calls to Zoho Desk, then moving your authtokens to Zoho OAuth can be done via a Migration API.
Choose the appropriate path based on the type of app you've created:
Choose the appropriate path based on the type of app you've created:
1. Migration for Web-based Applications: If your API application is used by multiple users, and user information is used to generate authtokens, follow the next few steps for a successful migration:
-
Fill this form with information about your authtoken use cases. Our support team will verify your details, and provide assistance in setting up Zoho OAuthTokens for your portal.
-
Once you receive confirmation from the support team, use the following API to complete the migration process.
|
Migration API Sample Format
https://accounts.zoho.com/oauth/v2/token/external/authtooauth?client_id=%3COAuth clientID>&client_secret=<OAuthClientsecret>&grant_type=authtooauth&authtoken=<Authtoken to be migrated>&soid=ZohoSupport.<
orgId of Zoho Desk portal>
Sample API Request
&authtoken=a99fxxxxxxxxxxx215&soid=ZohoSupport.1234567
Request Type
Post
Sample Response
{
"access_token": "1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf",
"refresh_token": "1000.b8xxxxxxxxxxxxxxxx58f.538b3xxxxxxxxxxxxxxxxx114",
"expires_in_sec": 3600,
"token_type": "Bearer",
"expires_in": 3600000
}
Note
Upon receiving this API call, we will verify the details you provide with the pre-shared details. The API call will fail if there is a mismatch between the pre-shared details and the details mentioned in the API call, so please ensure that there are no discrepancies. The (old) authtokens you have requested to migrate, will be deleted after 24 hours. |
2. Migration for Self-Client Applications: In the event that you have full control over your authtokens (applicable to apps that perform backend functions within a firm), you can directly migrate your authtokens to Zoho OAuth without our support team's help. Follow the steps given below for a successful migration.
|
Migration API Sample Format
https://accounts.zoho.com/oauth/v2/token/self/authtooauth?client_id=%3COAuth clientID>&client_secret=
<OAuth Client secret>&grant_type=authtooauth&authtoken=<Authtoken to be migrated>&scope=<oauth scopes>&soid=ZohoSupport.<orgId of Zoho Desk portal>
Sample API Request
https://accounts.zoho.com/oauth/v2/token/self/authtooauth? client_id=1000.T9GxxxxxxxxxxxxxxxxxTS&client_secret=e9xxxxxxxxxxxxxxxxxxxxxx798&grant_type=
authtooauth&authtoken=feexxxxxxxxxxxxxxxxxxxf59e&scope=Desk.tickets.ALL&soid=ZohoSupport.123467
Request Type
Post
Sample Response
{
"access_token": "1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
"refresh_token": "1000.95xxxxxxxxxxxxxxxb0de.10bxxxxxxxxxxxxxxxxxx31b",
"expires_in_sec": 3600,
"token_type": "Bearer",
"expires_in": 3600000
}
Note
Upon receiving this API call, we will match the ID you register with on Zoho OAuth, with the account that the Authtokens belong to, to establish the correct ownership. The (old) authtokens you have requested to migrate, will be deleted after 24 hours.
|
Custom Functions
Changing the authtoken mechanism within your custom functions is easy with Connections, a type of wrapper that helps you migrate to Zoho OAuth with a few simple steps. Let us look at how to replace authtokens with connections in a sample custom function. It is a 3-step process that involves creating a connection, removing authtoken parameters, and adding connection parameters.
- Click the Setup icon (
) in the top bar.
- Click Connections under the Developer Space menu.
You will land on the My Connections page, which will list the connections created by you. - Click the Create Connection button in the top right corner of the page.
- On the Create Connection page, pick a service type.
- Enter the Connection Name and the Connection LinkName you intend to have.
- Select the Scope if required, depending on the application’s prerequisites.
- Click Create and Connect.
A summary page displaying the Link Name, Service Name, and Status of the Connection is shown.
Step 2: Removing authtoken parameter
- Remove the authtoken parameter (refer to image) in the existing function code.
Step 3: Adding connection parameter
- Add the "connection" parameter in the invokeurl method (refer to image) and then specify the Connection LinkName entered in Step 1 as its value.
- Click Save & Execute Script.
The custom function will now use connections instead of authtokens for authorization.
Connections
In some cases, connections may use authtokens as their authorization mechanism. We recommend migrating such connections to OAuth by following the steps mentioned below:
- Click the Setup icon (
- Click Connections under the Developer Space menu.
The My Connections page will indicate the connections using deprecated authtokens with the message "Expiring Soon." - Hover your mouse pointer over the connection, and then click Migrate To OAuth.
- On the Edit Connection page, select the necessary scopes (based on the API call)
Note: If you rename the connection, you must update the new name wherever the connection is used. - Click Update.
This will migrate the authtoken based connection to Oauth.
Third Party Apps and Marketplace Apps
If you've developed an app that uses authtokens for the authentication process, then it's time to migrate to Zoho OAuth. If the app has been built on Zoho Marketplace, you can use Connections to replace the existing authtokens with the new ones. Please refer to this page to learn more about defining authentication details for a Zoho Marketplace app. Once you create a Connection, copy the JSON response from the Connection to the plugin-manifest.json file of your app.
If you've developed a third-party app, then you must migrate your existing authentication mechanism to Zoho OAuth. Using Connections as a mode of migration is limited to apps listed on the Zoho Marketplace.
If you are an app user, then please note that only app developers can make this shift. Once they do, you must update the app, followed by a round of reauthorization to ensure that the updated app will function as before, with all the right permissions.
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Calling Customers Using Zoho PhoneBridge
A major part of an agent's day is spent on managing outbound and inbound support calls. What helps them in making these calls is a good phone system and ease of access to the essential details before the call. The Zoho PhoneBridge feature connects ...Integrating LINE with Zoho Desk
LINE Messaging App LINE is the fastest growing instant messaging app in the world, bringing agents closer to their customers and end-users. Send free messages and make voice calls or video calls anytime, anywhere. LINE is now available on a variety ...Zoho Connect Integration Blocks for GC
Integration blocks (previously known as System Blocks) simplify the complexities of configuring webhook blocks in GC by offering the same services as reusable blocks. This approach eliminates the need to create webhooks from scratch each time ...Importance of Zia Agents in Zoho Desk
The incorporation of AI in ticket management has empowered customer support by automating key processes like categorizing, prioritizing, and assigning of tickets. This has reduced the workload on agents and helped in routing tickets to the right ...Accessing Activities Module in iOS
The Activities module helps users track tasks, events, and calls, with each parameter having its own vital information like priority level, status, and due date. The tasks, events, and calls can either be stand-alone records or associated with ...
New to Zoho LandingPage?
Zoho LandingPage Resources