JDBC Driver for Google Data Catalog

Build 24.0.9062

GetOAuthAccessToken

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

NOTE:このストアドプロシージャを実行したのち、OAuthRefreshToken が結果セットの一部として返されなかった場合、Prompt 値をCONSENT に変更してプロシージャを再度実行します。これにより、アプリは強制的に再認証を行い、新しいトークン情報を送信します。

Input

Name Type Required Description
AuthMode String True The type of authentication mode to use.

使用できる値は次のとおりです。APP, WEB

デフォルト値はWEBです。

Verifier String False The verifier code returned by Google after permissions have been granted for the app to connect. WEB AuthMode only.
Scope String True The scope of access to Google APIs. By default, access to all APIs used by this data provider will be specified.

デフォルト値はhttps://www.googleapis.com/auth/cloud-platformです。

CallbackURL String False Determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console (including the HTTP or HTTPS schemes, capitalization, and trailing '/').
Prompt String True This field indicates the prompt to present the user. It accepts one of the following values: NONE, CONSENT, SELECT ACCOUNT. The default is SELECT_ACCOUNT, so a given user will be prompted to select the account to connect to. If it is set to CONSENT, the user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user.

デフォルト値はSELECT_ACCOUNTです。

AccessType String True Indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to OFFLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user.

使用できる値は次のとおりです。ONLINE, OFFLINE

デフォルト値はOFFLINEです。

State String False Indicates any state which 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 the Google authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.

Result Set Columns

Name Type Description
OAuthAccessToken String The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular 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 24.0.9062