GetOAuthAccessToken
Obtains the OAuth access token to be used for authentication with various Google services.
NOTE: If, after running this stored procedure, the OAuthRefreshToken was not returned as part of the result set, change the Prompt value to CONSENT and run the procedure again. This forces the app to reauthenticate and send new token information.
Input
| Name | Type | Description |
| AuthMode | String | The type of authentication mode to use.
The allowed values are APP, WEB. The default value is WEB. |
| Verifier | String | The verifier code returned by Google after permissions have been granted for the app to connect. WEB Authmode only. |
| Scope | String | The scope of access to Google APIs. By default, access to all APIs used by this data provider will be specified. |
| CallbackURL | String | 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, case, and trailing '/'). |
| 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 | 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.
The allowed values are ONLINE, OFFLINE. The default value is OFFLINE. |
| State | String | Indicates any state which may be useful to your application upon receipt of the response. The Google Authorization Server roundtrips this parameter, so your application receives the same value it sent. Possible uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
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. |