JDBC Driver for Amazon Athena

Build 22.0.8462

GetOAuthAccessToken

If using a Windows application, set Authmode to App. If using a Web app, set Authmode to Web and specify the Verifier obtained by GetOAuthAuthorizationUrl.

Input

Name Type Required Description
Authmode String False The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.

The allowed values are APP, WEB.

The default value is APP.

Verifier String False The verifier token returned after using the URL obtained with GetOAuthAuthorizationUrl.
CallbackUrl String False The page to return the user to after authorization is complete.
State String False Any value that you wish to be sent with the callback.
GrantType String False Authorization grant type. Only available for OAuth 2.0. If left unspecified, the default value is the value of the OAuthGrantType connection property.

The allowed values are CODE, PASSWORD.

Prompt String False Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app.

Result Set Columns

Name Type Description
OAuthAccessToken String The OAuth access token.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token. A -1 denotes that it will not expire.

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