Connecting to ZohoDesk

To authenticate to ZohoDesk, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

Using OAuth Authentication

First, you will need to register an OAuth application with ZohoDesk. To do so, go to Zoho Developer Console, add a new Client (Server-based application) and set a valid OAuth redirect URL. Your Oauth application will be assigned a client id and a client secret. Additionally, you will need to set the relevant Domain (com, eu, in, cn etc.), defaults to com and Organization. Set Organization to Organization Id that you can find in Organizations table.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to OAuth.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
OAuthClientId: Set this to the client_id that is specified in you app settings.
OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
CallbackURL: Set this to the Redirect URI that is specified in your app settings
Domain: Optionally, set this in ProfileSettings to your ZohoDesk account domain
Organization: Set this in ProfileSettings to your Organizaiton Id. See Organizations table for details

Example connection string:

Profile=C:\profiles\ZohoDesk.apip;ProfileSettings='Domain=your_domain;Organization=your_organization_id';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are None or OAuth. Allowed values are: BASIC, NONE, NTLM, OAUTH, OAUTH_CLIENT
CallbackURL	The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Domain	Determines the domain where authentication calls will be sent to. Allowed values are: COM, EU, COM.AU, IN
InitiateOAuth	Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Organization	The Id associated with the specific Zoho Desk organization you wish to connect to. Get it from Organizations table.