JDBC Driver for Smartsheet

Build 23.0.8839

GetOAuthAccessToken

Gets the OAuth access token from Smartsheet.

Stored Procedure Specific Information

To execute this stored procedure, you must specify at least the OAuthClientId and OAuthClientSecret connection properties.

Additionally, you should also make sure the CallbackURL connection property or the 'CallbackUrl' input parameter matches with the 'App redirect URL' configured in your OAuth App Profile.

Input

Name Type Required Description
AuthMode String False The type of authentication mode to use. Select App for getting authentication tokens via a windows forms app. Select Web for getting authentication tokens via a Web app.

The allowed values are APP, WEB.

The default value is APP.

Scope String False The scope or permissions you are requesting.

The default value is READ_SHEETS READ_USERS READ_CONTACTS WRITE_SHEETS ADMIN_SHEETS CREATE_SHEETS DELETE_SHEETS.

CallbackUrl String False The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Smartsheet app settings. Only needed when the Authmode parameter is Web.
Verifier String False The verifier returned from Smartsheet after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL.
State String False An arbitrary string of your choosing that is returned to your app; a successful roundtrip of this string helps ensure that your app initiated the request.

Result Set Columns

Name Type Description
OAuthAccessToken String The OAuth token.
OAuthRefreshToken String The OAuth refresh token.
ExpiresIn String The remaining lifetime for the access token in seconds.

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