Migration for Self-Client Applications

Purpose

To generate access and refresh tokens from the existing auth token.

Use this option when your application is a standalone server-side application performing a back-end job, and you do not have a domain and a redirect URL.

How it Works?

  1. The external application accesses the "Migration for Self-Client Applications" API with client ID, client secret, auth token, and the required oauth scopes.

  2. Zoho Accounts checks whether the service names of the auth token and oauth scopes match.

  3. After scope validation, Accounts checks whether the application owner is the same as the Auth token owner.

  4. If the validation is successful, Accounts generates an OAuth token for the external application.
    Otherwise, the system throws the error "access_denied".

  5. Accounts sends an email to the user about client upgrade.

Request URL

https://accounts.zoho.com/oauth/v2/token/self/authtooauth

Request Method

POST

Parameters

Parameter NameData TypeDescription
client_idStringSpecify the client ID you obtained while registering your application
client_secretStringSpecify the client secret generated from the connected application
grant_typeStringThe grant type must be authtooauth
authtokenStringSpecify your auth token
scopeStringSpecify the OAuth scopes to access data from Zoho Recruit.
For more details about Zoho Recruit scopes, refer What's New section of the Zoho Recruit REST API Documentation.

Possible Errors

Error MessageReason
invalid_grantThe grant_type is not specified as authtooauth
access_deniedThe authtoken you specified is already used to generate an OAuth token
invalid_clientThe client ID you specified is wrong
invalid_authtokenThe auth token you specified is wrong
invalid_scopeThe OAuth scope you specified is invalid
Note:
  • The maximum number of migration requests you can make per minute is 25 and per hour is 60.

  • After the generation of an OAuthtoken, the system deletes the old auth token after 1 day.

Sample Response

Copied{
"access_token": "1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
"refresh_token": "1000.95xxxxxxxxxxxxxxxb0de.10bxxxxxxxxxxxxxxxxxx31b",
"expires_in": 3600,
"token_type": "Bearer"
}