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;
Usage Examples
AccessibleOrganizations:
SELECT * FROM AccessibleOrganizations
AccountComments:
SELECT * FROM AccountComments WHERE AccountId = 'account123'
AccountContacts:
SELECT * FROM AccountContacts WHERE AccountId = 'account123'
AccountContracts:
SELECT * FROM AccountContracts WHERE AccountId = 'account123'
AccountDeDuplicationDefaultFieldName:
SELECT * FROM AccountDeDuplicationDefaultFieldName
AccountFollowers:
SELECT * FROM AccountFollowers WHERE AccountId = 'account123'
AccountHistory:
SELECT * FROM AccountHistory WHERE AccountId = 'account123'
AccountProducts:
SELECT * FROM AccountProducts WHERE AccountId = 'account123'
AccountSearch:
SELECT * FROM AccountSearch
AccountSla:
SELECT * FROM AccountSla WHERE AccountId = 'account123'
AccountStatistics:
SELECT * FROM AccountStatistics WHERE AccountId = 'account123'
AccountTickets:
SELECT * FROM AccountTickets WHERE AccountId = 'account123'
AccountTimeEntry:
SELECT * FROM AccountTimeEntry WHERE AccountId = 'account123'
AccountTimeEntrySummation:
SELECT * FROM AccountTimeEntrySummation WHERE AccountId = 'account123'
Accounts:
SELECT * FROM Accounts
ActiveTimer:
SELECT * FROM ActiveTimer WHERE Module = 'module_value' AND ModuleId = 'id123'
ActivitiesSearch:
SELECT * FROM ActivitiesSearch
AgentAvailability:
SELECT * FROM AgentAvailability WHERE DepartmentId = 'dept123'
AgentAvailabilityConfiguration:
SELECT * FROM AgentAvailabilityConfiguration
AgentByEmail:
SELECT * FROM AgentByEmail WHERE EmailId = 'id123'
AgentByIds:
SELECT * FROM AgentByIds WHERE Id = 'agent147'
AgentSignatures:
SELECT * FROM AgentSignatures WHERE AgentId = 'agent123'
AgentSkills:
SELECT * FROM AgentSkills WHERE AgentId = 'agent123'
AgentTeams:
SELECT * FROM AgentTeams WHERE AgentId = '258741'
AgentTicketsCount:
SELECT * FROM AgentTicketsCount
AgentTimeEntry:
SELECT * FROM AgentTimeEntry WHERE AgentId = 'agent123'
AgentTimeEntrySummation:
SELECT * FROM AgentTimeEntrySummation WHERE AgentId = 'agent123'
Agents:
SELECT * FROM Agents
AllActiveTimers:
SELECT * FROM AllActiveTimers WHERE DepartmentId = 'dept123'
ArchivedTickets:
SELECT * FROM ArchivedTickets WHERE DepartmentId = '963753'
ArticleComments:
SELECT * FROM ArticleComments WHERE ArticleId = 'article123' AND Locale = 'locale_value'
ArticleFeedbacks:
SELECT * FROM ArticleFeedbacks
ArticleHistory:
SELECT * FROM ArticleHistory WHERE ArticleId = 'article123'
ArticleInsights:
SELECT * FROM ArticleInsights WHERE ArticleId = 'article123'
ArticleSearch:
SELECT * FROM ArticleSearch
ArticleTranslationSearch:
SELECT * FROM ArticleTranslationSearch WHERE SearchString = 'abc'
ArticleTranslationSearchByTag:
SELECT * FROM ArticleTranslationSearchByTag WHERE AssociatedTag = 'abc'
ArticleTranslations:
SELECT * FROM ArticleTranslations WHERE ArticleId = 'article123'
Articles:
SELECT * FROM Articles
AssociatedTickets:
SELECT * FROM AssociatedTickets
Attachments:
SELECT * FROM Attachments WHERE ModuleId = 'id123' AND FetchModule = 'fetchmodule_value'
AutomationFeatureCount:
SELECT * FROM AutomationFeatureCount WHERE Feature = 'feature_value'
AvailableBadgeIcons:
SELECT * FROM AvailableBadgeIcons
AvailableDependencyMappings:
SELECT * FROM AvailableDependencyMappings WHERE LayoutId = 'layout456'
BadgeUsers:
SELECT * FROM BadgeUsers WHERE BadgeId = 'badge123'
Badges:
SELECT * FROM Badges
Blueprints:
SELECT * FROM Blueprints WHERE Module = 'tickets'
BugTickets:
SELECT * FROM BugTickets WHERE BugId = 'id123'
BulkExport:
SELECT * FROM BulkExport WHERE ExportId = 'export123'
BusinessHourRelatedRules:
SELECT * FROM BusinessHourRelatedRules WHERE BusinessHourId = 'id123'
BusinessHours:
SELECT * FROM BusinessHours
CallComments:
SELECT * FROM CallComments WHERE CallId = 'call123'
CallSearch:
SELECT * FROM CallSearch
Calls:
SELECT * FROM Calls
Channels:
SELECT * FROM Channels
CommentHistory:
SELECT * FROM CommentHistory WHERE TicketId = 'ticket123' AND CommentId = 'comment123'
CommunityCategory:
SELECT * FROM CommunityCategory
CommunityCategoryByPermalink:
SELECT * FROM CommunityCategoryByPermalink WHERE Permalink = 'permalink_value'
CommunityCategoryFollowers:
SELECT * FROM CommunityCategoryFollowers WHERE CategoryId = 'category123'
CommunityModeratedTopics:
SELECT * FROM CommunityModeratedTopics
CommunityModeratedUsers:
SELECT * FROM CommunityModeratedUsers
CommunityModerationComments:
SELECT * FROM CommunityModerationComments
CommunityModerationCounts:
SELECT * FROM CommunityModerationCounts
CommunityModerationTopics:
SELECT * FROM CommunityModerationTopics
CommunityMyDraftedTopics:
SELECT * FROM CommunityMyDraftedTopics
CommunityPreferences:
SELECT * FROM CommunityPreferences
CommunityTopicComments:
SELECT * FROM CommunityTopicComments WHERE TopicId = 'topic123'
CommunityTopicFollowerParticipantVoter:
SELECT * FROM CommunityTopicFollowerParticipantVoter WHERE TopicId = 'topic123' AND TopicType = 'topictype_value'
CommunityTopicPermalinks:
SELECT * FROM CommunityTopicPermalinks WHERE TopicId = 'topic123'
CommunityTopicTypes:
SELECT * FROM CommunityTopicTypes
CommunityTopics:
SELECT * FROM CommunityTopics WHERE Permalink = 'permalink_value'
CommunityUserComments:
SELECT * FROM CommunityUserComments WHERE UserId = 'id123'
CommunityUserFollowers:
SELECT * FROM CommunityUserFollowers WHERE UserId = 'id123'
CommunityUserTopics:
SELECT * FROM CommunityUserTopics WHERE UserId = 'id123'
CommunityUsers:
SELECT * FROM CommunityUsers WHERE Id = 'id123'
ContactAccounts:
SELECT * FROM ContactAccounts WHERE ContactId = 'contact123'
ContactByIds:
SELECT * FROM ContactByIds WHERE Id = 'contact789'
ContactComments:
SELECT * FROM ContactComments WHERE ContactId = 'contact123'
ContactDeDuplicationDefaultFieldName:
SELECT * FROM ContactDeDuplicationDefaultFieldName
ContactFollowers:
SELECT * FROM ContactFollowers WHERE ContactId = 'contact123'
ContactHelpCenters:
SELECT * FROM ContactHelpCenters WHERE ContactId = 'contact123'
ContactHistory:
SELECT * FROM ContactHistory WHERE ContactId = 'contact123'
ContactProducts:
SELECT * FROM ContactProducts WHERE ContactId = 'contact123'
ContactProfiles:
SELECT * FROM ContactProfiles WHERE ContactId = 'contact123'
ContactSearch:
SELECT * FROM ContactSearch
ContactStatistics:
SELECT * FROM ContactStatistics WHERE ContactId = 'contact123'
ContactTickets:
SELECT * FROM ContactTickets WHERE ContactId = 'contact123'
ContactTimeEntry:
SELECT * FROM ContactTimeEntry WHERE ContactId = 'contact123'
ContactTimeEntrySummation:
SELECT * FROM ContactTimeEntrySummation WHERE ContactId = 'contact123'
Contacts:
SELECT * FROM Contacts
ContractComments:
SELECT * FROM ContractComments WHERE ContractId = 'contract123'
Contracts:
SELECT * FROM Contracts
Countries:
SELECT * FROM Countries
CreditUsers:
SELECT * FROM CreditUsers WHERE CreditId = 'id123'
Credits:
SELECT * FROM Credits
CustomFieldCount:
SELECT * FROM CustomFieldCount WHERE DepartmentId = 'dept123' AND Module = 'tickets'
CustomerHappiness:
SELECT * FROM CustomerHappiness WHERE DepartmentId = 'dept123'
CustomerHappinessContent:
SELECT * FROM CustomerHappinessContent WHERE ThreadId = 'id123'
CustomerHappinessLinkHolder:
SELECT * FROM CustomerHappinessLinkHolder WHERE DepartmentId = 'dept123'
DashboardResponseCount:
SELECT * FROM DashboardResponseCount WHERE GroupBy = 'groupby_value' AND Duration = 'duration_value'
DashboardResponseTime:
SELECT * FROM DashboardResponseTime WHERE GroupBy = 'groupby_value' AND IsFirstResponse = 'isfirstresponse_value' AND Duration = 'duration_value'
DashboardTickets:
SELECT * FROM DashboardTickets WHERE TicketType = 'tickettype_value' AND GroupBy = 'groupby_value' AND Duration = 'duration_value'
DashboardTicketsResolutionTime:
SELECT * FROM DashboardTicketsResolutionTime WHERE GroupBy = 'groupby_value' AND Duration = 'duration_value'
DataSharingRules:
SELECT * FROM DataSharingRules
DepartmentAgents:
SELECT * FROM DepartmentAgents WHERE DepartmentId = 'dept123'
DepartmentByIds:
SELECT * FROM DepartmentByIds WHERE Id = '123456'
DepartmentCheckExists:
SELECT * FROM DepartmentCheckExists WHERE DepartmentName = 'testname'
DepartmentMailConfigurations:
SELECT * FROM DepartmentMailConfigurations WHERE DepartmentId = 'dept123'
DepartmentTeams:
SELECT * FROM DepartmentTeams WHERE DepartmentId = '654987'
Departments:
SELECT * FROM Departments
DependencyMappings:
SELECT * FROM DependencyMappings WHERE LayoutId = 'layout456'
Domains:
SELECT * FROM Domains
DuplicateAccountDetails:
SELECT * FROM DuplicateAccountDetails WHERE FieldName = 'fieldname_value' AND FieldValue = 'fieldvalue_value'
EmailFailureAlerts:
SELECT * FROM EmailFailureAlerts WHERE DepartmentId = '456789'
EventComments:
SELECT * FROM EventComments WHERE EventId = 'id123'
EventSearch:
SELECT * FROM EventSearch
Events:
SELECT * FROM Events
Followers:
SELECT * FROM Followers WHERE ModuleName = 'modulename_value'
GroupDuplicateValues:
SELECT * FROM GroupDuplicateValues WHERE EntityType = 'entitytype_value'
GroupUsers:
SELECT * FROM GroupUsers WHERE GroupId = 'group123'
Groups:
SELECT * FROM Groups
HelpCenters:
SELECT * FROM HelpCenters
HolidayList:
SELECT * FROM HolidayList
IMCannedMessages:
SELECT * FROM IMCannedMessages WHERE DepartmentId = '741159'
IMChannels:
SELECT * FROM IMChannels
IMMetricSessionTimeSeries:
SELECT * FROM IMMetricSessionTimeSeries WHERE Duration = 'duration_value' AND Granularity = 'granularity_value' AND Dimension = 'dimension_value' AND DimensionValue = 'dimensionvalue_value'
IMSessions:
SELECT * FROM IMSessions
Imports:
SELECT * FROM Imports WHERE Id = 'id123'
InvoiceTickets:
SELECT * FROM InvoiceTickets WHERE InvoiceId = 'id123'
JiraIssueTickets:
SELECT * FROM JiraIssueTickets WHERE IssueId = 'id123'
KbCategoryRepositionArticles:
SELECT * FROM KbCategoryRepositionArticles WHERE CategoryId = 'category123'
KbRootCategories:
SELECT * FROM KbRootCategories
KbRootCategoriesCategoryTree:
SELECT * FROM KbRootCategoriesCategoryTree WHERE Id = 'id123'
KbRootCategoriesReviewOwners:
SELECT * FROM KbRootCategoriesReviewOwners WHERE RootCategoryId = 'id123'
KbSections:
SELECT * FROM KbSections WHERE SectionId = 'secid1234'
LabelUsers:
SELECT * FROM LabelUsers WHERE LabelId = 'label123'
Labels:
SELECT * FROM Labels
Languages:
SELECT * FROM Languages
LastAccessedView:
SELECT * FROM LastAccessedView WHERE FetchModule = 'tickets'
LayoutProfiles:
SELECT * FROM LayoutProfiles WHERE LayoutId = 'layout123'
LayoutRuleCriteriaFields:
SELECT * FROM LayoutRuleCriteriaFields WHERE LayoutId = 'layout123'
LayoutRules:
SELECT * FROM LayoutRules WHERE LayoutId = 'layout123'
Layouts:
SELECT * FROM Layouts WHERE Module = 'module_value'
Levels:
SELECT * FROM Levels
LightAgentProfile:
SELECT * FROM LightAgentProfile
MailConfigurations:
SELECT * FROM MailConfigurations
MailReplyAddress:
SELECT * FROM MailReplyAddress WHERE DepartmentId = '789456'
MetricsAgents:
SELECT * FROM MetricsAgents WHERE Duration = 'TODAY' AND Attributegroup = 'RESPONSIVENESS' AND Attributes = 'AVG_RESPONSE_TIME'
MyActiveTimers:
SELECT * FROM MyActiveTimers WHERE DepartmentId = 'dept123'
MyForm:
SELECT * FROM MyForm
MyModules:
SELECT * FROM MyModules
MyPendingApprovals:
SELECT * FROM MyPendingApprovals WHERE DepartmentId = '753357'
MyPreferences:
SELECT * FROM MyPreferences
MyProfile:
SELECT * FROM MyProfile
MyProfilePermissions:
SELECT * FROM MyProfilePermissions
Myinfo:
SELECT * FROM Myinfo
OfflineAgents:
SELECT * FROM OfflineAgents WHERE DepartmentId = 'dept123'
OnlineAgents:
SELECT * FROM OnlineAgents WHERE DepartmentId = '357741'
OrganizationFieldCriteriaReferences:
SELECT * FROM OrganizationFieldCriteriaReferences WHERE FieldId = 'id123' AND FilterFeatureType = 'filterfeaturetype_value'
OrganizationFieldPermissions:
SELECT * FROM OrganizationFieldPermissions WHERE FieldId = 'id123'
OrganizationFields:
SELECT * FROM OrganizationFields WHERE FetchModule = 'tickets'
OrganizationModules:
SELECT * FROM OrganizationModules
Organizations:
SELECT * FROM Organizations
PermalinkAvailability:
SELECT * FROM PermalinkAvailability WHERE Permalink = 'custom-section'
PersonalRole:
SELECT * FROM PersonalRole
ProductAccounts:
SELECT * FROM ProductAccounts WHERE ProductId = 'product123'
ProductContacts:
SELECT * FROM ProductContacts WHERE ProductId = 'product123'
ProductSearch:
SELECT * FROM ProductSearch
ProductSearchDuplicates:
SELECT * FROM ProductSearchDuplicates WHERE ProductName = 'Premium Support'
ProductTickets:
SELECT * FROM ProductTickets WHERE ProductId = 'product123'
Products:
SELECT * FROM Products
ProfileAgents:
SELECT * FROM ProfileAgents WHERE ProfileId = 'id123'
Profiles:
SELECT * FROM Profiles
RecycleBin:
SELECT * FROM RecycleBin
RoleAgents:
SELECT * FROM RoleAgents WHERE RoleId = 'role123'
RoleByIds:
SELECT * FROM RoleByIds WHERE Id = 'role456'
RoleTeams:
SELECT * FROM RoleTeams WHERE RoleId = '147963'
Roles:
SELECT * FROM Roles
RoutingPreferences:
SELECT * FROM RoutingPreferences WHERE DepartmentId = '159741'
Search:
SELECT * FROM Search
SkillConfiguration:
SELECT * FROM SkillConfiguration WHERE DepartmentId = '369159'
SkillCriteriaFields:
SELECT * FROM SkillCriteriaFields WHERE DepartmentId = '357159' AND FetchModule = 'tickets'
SkillRelatedRules:
SELECT * FROM SkillRelatedRules WHERE Skillid = 'skillid_value'
SkillTypes:
SELECT * FROM SkillTypes
Skills:
SELECT * FROM Skills WHERE DepartmentId = '741852'
StandardLayoutFormat:
SELECT * FROM StandardLayoutFormat WHERE FetchModule = 'tickets'
StarredViews:
SELECT * FROM StarredViews
SubjectAccessRequestFieldsAndConditions:
SELECT * FROM SubjectAccessRequestFieldsAndConditions WHERE FetchModule = 'tickets'
SubjectAccessRequests:
SELECT * FROM SubjectAccessRequests
SupportEmailDomain:
SELECT * FROM SupportEmailDomain
SupportPlans:
SELECT * FROM SupportPlans WHERE DepartmentId = '951147'
SupportedEmailAddress:
SELECT * FROM SupportedEmailAddress WHERE DepartmentId = '357963'
TagSearch:
SELECT * FROM TagSearch WHERE DepartmentId = '357963'
TagTickets:
SELECT * FROM TagTickets WHERE TagId = 'id123'
TaskComments:
SELECT * FROM TaskComments WHERE TaskId = 'task123'
TaskSearch:
SELECT * FROM TaskSearch
TaskTimeEntry:
SELECT * FROM TaskTimeEntry WHERE TaskId = 'task123'
TaskTimeEntrySummation:
SELECT * FROM TaskTimeEntrySummation WHERE TaskId = 'task123'
Tasks:
SELECT * FROM Tasks
TeamAssociables:
SELECT * FROM TeamAssociables WHERE TeamId = '1234'
TeamMembers:
SELECT * FROM TeamMembers
Teams:
SELECT * FROM Teams
TemplateFolders:
SELECT * FROM TemplateFolders WHERE departmentId = 'id123'
TemplatePlaceholders:
SELECT * FROM TemplatePlaceholders WHERE departmentId = 'id123'
Templates:
SELECT * FROM Templates WHERE departmentId = 'id123'
ThreadOriginalContent:
SELECT * FROM ThreadOriginalContent WHERE TicketId = 'ticket123' AND ThreadId = 'id123'
TicketActivities:
SELECT * FROM TicketActivities WHERE TicketId = 'ticket123'
TicketApprovals:
SELECT * FROM TicketApprovals WHERE TicketId = 'ticket123'
TicketArticleSuggestion:
SELECT * FROM TicketArticleSuggestion WHERE TicketId = 'ticket123'
TicketBlueprint:
SELECT * FROM TicketBlueprint WHERE TicketId = 'ticket123'
TicketCalls:
SELECT * FROM TicketCalls WHERE TicketId = 'ticket123'
TicketComments:
SELECT * FROM TicketComments WHERE TicketId = 'ticket123'
TicketConversations:
SELECT * FROM TicketConversations WHERE TicketId = 'ticket123'
TicketCountByFieldValues:
SELECT * FROM TicketCountByFieldValues WHERE Field = 'field_value'
TicketEvents:
SELECT * FROM TicketEvents WHERE TicketId = 'ticket123'
TicketFollowers:
SELECT * FROM TicketFollowers WHERE TicketId = 'ticket123'
TicketHistory:
SELECT * FROM TicketHistory WHERE TicketId = 'ticket123'
TicketLatestThread:
SELECT * FROM TicketLatestThread WHERE TicketId = 'ticket123'
TicketMetrics:
SELECT * FROM TicketMetrics WHERE TicketId = 'ticket123'
TicketPins:
SELECT * FROM TicketPins WHERE TicketId = 'ticket123'
TicketResolution:
SELECT * FROM TicketResolution WHERE TicketId = 'ticket123'
TicketResolutionHistory:
SELECT * FROM TicketResolutionHistory WHERE TicketId = 'ticket123'
TicketSearch:
SELECT * FROM TicketSearch
TicketTags:
SELECT * FROM TicketTags WHERE TicketId = 'ticket123'
TicketTasks:
SELECT * FROM TicketTasks WHERE TicketId = 'ticket123'
TicketTemplates:
SELECT * FROM TicketTemplates WHERE DepartmentId = '357963'
TicketThreads:
SELECT * FROM TicketThreads WHERE TicketId = 'ticket123'
TicketTimeEntry:
SELECT * FROM TicketTimeEntry WHERE TicketId = 'ticket123'
TicketTimeEntryByBillingType:
SELECT * FROM TicketTimeEntryByBillingType WHERE TicketId = 'ticket123'
TicketTimeEntrySummation:
SELECT * FROM TicketTimeEntrySummation WHERE TicketId = 'ticket123'
TicketTransitionForm:
SELECT * FROM TicketTransitionForm WHERE TicketId = 'ticket123' AND TransitionId = 'id123'
Tickets:
SELECT * FROM Tickets
TimeTrackHistory:
SELECT * FROM TimeTrackHistory WHERE DepartmentId = '357963'
TimeTrackSettings:
SELECT * FROM TimeTrackSettings WHERE DepartmentId = '357963'
TimeZones:
SELECT * FROM TimeZones
Timer:
SELECT * FROM Timer WHERE Module = 'module_value' AND ModuleId = 'id123'
TranslationAttachments:
SELECT * FROM TranslationAttachments WHERE ArticleId = 'article123' AND Locale = 'locale_value'
TranslationComments:
SELECT * FROM TranslationComments WHERE ArticleId = 'article123' AND Locale = 'locale_value'
TranslationFeedbacks:
SELECT * FROM TranslationFeedbacks WHERE ArticleId = 'article123' AND Locale = 'locale_value'
TranslationPermalinks:
SELECT * FROM TranslationPermalinks WHERE ArticleId = 'article123' AND Locale = 'locale_value'
UserBadges:
SELECT * FROM UserBadges WHERE UserId = 'id123'
UserGroups:
SELECT * FROM UserGroups WHERE UserId = 'id123'
UserLabels:
SELECT * FROM UserLabels WHERE UserId = 'id123'
Users:
SELECT * FROM Users
ValidationRuleCriteriaFields:
SELECT * FROM ValidationRuleCriteriaFields WHERE LayoutId = 'layout123'
ValidationRules:
SELECT * FROM ValidationRules WHERE LayoutId = 'layout123'
Views:
SELECT * FROM Views WHERE FetchModule = 'tickets'
VoterTrend:
SELECT * FROM VoterTrend WHERE TopicId = 'topic123'
ZohoFinanceEstimates:
SELECT * FROM ZohoFinanceEstimates WHERE Financeservice = 'financeservice_value'
ZohoFinanceInvoices:
SELECT * FROM ZohoFinanceInvoices WHERE FinanceService = 'financeservice_value'
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, APIKEY, OAUTH_CLIENT |
| CallbackURL | Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only). |
| Domain | Determines the domain where authentication calls will be sent to. Allowed values are: MIXPANEL, EU.MIXPANEL, IN.MIXPANEL, .COM, .EU, .COM.AU, .IN, COM, EU, COM.AU, IN, .COM.CN, .JP |
| InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. Allowed values are: OFF, REFRESH, GETANDREFRESH |
| OAuthAccessToken | Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
| Organization | The Id associated with the specific Zoho Desk organization you wish to connect to. Get it from Organizations table. |
| Scope | Scope(s) to use when authenticating, that control access to specific information. |