GetOAuthAccessToken
Gets the OAuth access token and OAuth secret key from Intuit.
Input
Name | Type | Description |
AuthMode | String | The authentication mode required for the type of the application. If using a Windows or desktop application, set Authmode to App. If you choose the App mode, you do not need specify the verifier, token, or secret key. Calling this stored procedure will launch your browser and open the user consent page. If you are authenticating a Web app, set Authmode to Web and specify the AuthToken, AuthKey, and Verifier returned by GetOAuthAuthorizationURL.
The allowed values are APP, WEB. The default value is APP. |
Verifier | String | The verifier token returned by Intuit after accessing the URL obtained with GetOAuthAuthorizationURL. |
Scope | String | The scope of access to QuickBooksOnline APIs. By default, you will only need access to the accounting API.
The default value is com.intuit.quickbooks.accounting. |
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, capitalization, and trailing '/'). |
State | String | 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 QuickBooksOnline 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 OAuth token. |
OAuthRefreshToken | String | The OAuth refresh token. |
CompanyId | String | The company id for the company file that was authorized. |
ExpiresIn | String | When the OAuth access token will expire. |