GetOAuthAuthorizationURL
Obtains the OAuth authorization URL used for authentication with data sources using OAuth.
Input
Name | Type | Description |
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. |
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. |
Scope | String | The scope of access to the APIs. By default, access to all APIs used by this data provider will be specified. |
CallbackURL | String | The URL the user will be redirected to after authorizing your application. |
Prompt | String | 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.
The default value is SELECT_ACCOUNT. |
AccessType | String | 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 | 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 the Google authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Other_Options | String | Other options to control the behavior of OAuth. |
Result Set Columns
Name | Type | Description |
AuthToken | String | The authorization token, passed into the GetOAuthAccessToken stored procedure. |
AuthKey | String | The authorization secret token, passed into the GetOAuthAccessToken stored procedure. |
AuthSecret | String | A legacy name used for AuthKey, accepted for compatibility. |
URL | String | The URL to complete user authentication. |
PKCEVerifier | String | A random value used as input for GetOAuthAccessToken. Only provided when AuthScheme=OAuthPKCE. |