Cmdlets for Parquet

Build 24.0.9062

GetOAuthAccessToken

Obtains the OAuth access token to be used for authentication with data sources using OAuth.

Input

Name Type Required Description
Other_Options String False Other options to control behavior of OAuth.
Cert String False Path for a personal certificate .pfx file. Only available for OAuth 1.0.
Cert_Password String False Personal certificate password. Only available for OAuth 1.0.
AuthToken String False The request token returned by GetOAuthAuthorizationUrl. Available only for OAuth 1.0.
AuthKey String False The request secret key returned by GetOAuthAuthorizationUrl. Available only for OAuth 1.0.
AuthSecret String False TThe legacy name for AuthKey, included for compatibility.
Sign_Method String False The signature method used to calculate the signature for OAuth 1.0.

使用できる値は次のとおりです。HMAC-SHA1, PLAINTEXT

デフォルト値はHMAC-SHA1です。

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

使用できる値は次のとおりです。CODE, PASSWORD, CLIENT, REFRESH

Post_Data String False The post data to submit, if any.
AuthMode String False The type of authentication mode to use.

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

デフォルト値はWEBです。

Verifier String False The verifier code returned by the data source after permission for the app to connect has been granted. WEB AuthMode only.
Scope String False The scope of access to the APIs. By default, access to all APIs used by this data provider will be specified.
CallbackURL String False This field determines where the response is sent.
Prompt String False 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 False This field indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to ONLINE. 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.
State String False 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 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.
OAuthAccessTokenSecret String The OAuth access token secret.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.
* String Other outputs that may be returned by the data source.

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