API Data Provider - Online Help

GetOAuthAccessToken

Obtains the OAuth access token to be used for authentication with various APIs.

Input

Name Type Description
AuthMode String The OAuth flow. APP or WEB.

The allowed values are APP, WEB.

The default value is WEB.

CallbackURL String The URL to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access.
Verifier String The verifier code obtained when the user grants permissions to your app.
Scope String The scope of access to the API. By default, access to all APIs used by this data provider will be specified.

The default value is contact_read contact_write conversation_read conversation_write user_read user_write.

Result Set Columns

Name Type Description
OAuthAccessToken String The access token.
OAuthAccessTokenSecret String The new OAuthAccessTokenSecret returned from the service.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0