ODBC Driver for OData

Build 24.0.9060

GetOAuthAccessToken

Gets the auth token used to authenticate to the service.

Input

Name Type Description
AuthMode String The type of authentication you are attempting. Use App for a Windows application, or Web for Web-based applications.

The default value is APP.

Verifier String A verifier returned by the service that must be input to return the access token. Needed only when using the Web auth mode. Obtained by navigating to the URL returned in GetOAuthAuthorizationUrl.
CallbackUrl String The URL the user will be redirected to after authorizing your application.
Other_Options String Other options to control behavior of OAuth.
Cert String Path for a personal certificate .pfx file. Only available for OAuth 1.0.
Cert_Password String Personal certificate password. Only available for OAuth 1.0.
AuthToken String The request token returned by navigating to the URL returned by OAuthGetUserAuthorizationURL. Available only for OAuth 1.0.
AuthKey String The request secret key returned by OAuthGetUserAuthorizationURL. Available only for OAuth 1.0.
Sign_Method String The signature method used to calculate the signature for OAuth 1.0.

The allowed values are HMAC-SHA1, PLAINTEXT.

The default value is HMAC-SHA1.

GrantType String Authorization grant type. Only available for OAuth 2.0.

The allowed values are CODE, PASSWORD, CLIENT, REFRESH.

Post_Data String The post data to submit, if any.
OAuthParam:* String Other parameters may be defined in the format 'param:paramname'.

Result Set Columns

Name Type Description
OAuthAccessToken String The OAuth access token.
OAuthAccessTokenSecret String The OAuth access token secret.
* String Other outputs that may be returned by the data source.

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