FireDAC Components for Zoho CRM

Build 22.0.8462

GetOAuthAccessToken

Gets the OAuth access token from ZohoCRM.

Input

Name Type Description
AuthMode String The type of authentication mode to use. Select App for getting authentication tokens via a windows forms app. Select Web for getting authentication tokens via a Web app.

The allowed values are APP, WEB.

The default value is APP.

Scope String The scope or permissions you are requesting.

The default value is ZohoCRM.modules.visits.READ,ZohoCRM.modules.visits.DELETE,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,ZohoCRM.users.ALL,ZohoCRM.org.ALL,ZohoCRM.settings.territories.ALL,ZohoCRM.settings.currencies.READ,ZohoCRM.settings.currencies.CREATE,ZohoCRM.settings.currencies.UPDATE,ZohoCRM.settings.pipeline.UPDATE,ZohoCRM.settings.pipeline.READ,ZohoCRM.settings.pipeline.CREATE,ZohoCRM.settings.ALL,ZohoCRM.modules.Accounts.READ,ZohoCRM.modules.Leads.READ,ZohoSearch.securesearch.READ.

CallbackUrl String The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Square app settings. Only needed when the Authmode parameter is Web.
Verifier String The verifier returned from ZohoCRM after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL.
State String This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Zoho authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
AccountsServer String This field indicates the full Account Server URL.

Result Set Columns

Name Type Description
OAuthAccessToken String The OAuth token.
OAuthRefreshToken String The OAuth refresh token.
ExpiresIn String The remaining lifetime for the access token in seconds.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462