Smartsheet Connector
Documentation
Version: 1
Documentation

Authentication :: OAuth (Dynamic Token) [OAuth]


Description

No description available [API Help..]

Instructions

OAuth Walkthrough

Apps connect to Smartsheet using OAuth 2.0 to authenticate and authorize users. If you are building an app, this documentation will walk you through the steps you need to authenticate your users. The Smartsheet SDKs contain APIs for OAuth 2.0.

NOTE: For users of apps like AWS AppFabric, you will need a Tenant ID. You can find your Tenant ID in Admin Center under Security & Controls. There is a Smartsheet Tenant ID pane.

First Steps

Before you can start using OAuth 2.0 with your app, Smartsheet needs the following information:

  1. You must register with Smartsheet to get a developer account*. The developer account gives you access to "Developer Tools", which is where you manage your app.
  2. In "Developer Tools", complete any required fields in your developer profile.
  3. In "Developer Tools", register your app so Smartsheet can assign a client Id and a client secret to the app.
  4. Review the list of access scopes. You'll need to choose which ones your app needs to get to a user's Smartsheet data, and then ask the user to consent to that access.
  5. After you've worked through these steps, you'll be ready to implement the OAuth Flow.

Open Developer Tools

  1. Log in to Smartsheet with your developer account.
  2. Click the "Account" button in the lower-left corner of your Smartsheet screen, and then click "Developer Tools".
  3. Do one of the following:
    • If you need to register an app, click "Create New App".
    • If you need to manage an app, click "view/edit" for the app.

Register Your App Using Developer Tools

  1. Log in to Smartsheet with your developer account.
  2. Click the "Account" button in the upper-right corner of your Smartsheet screen, and then click "Developer Tools".
  3. In the "Create New App" form, provide the following information:
    • Name: the name the user sees to identify your app
    • Description: a brief description intended for the user
    • URL: the URL to launch your app, or the landing page if not a web app
    • Contact/support: support information for the user
    • Redirect URL: also known as a callback URL. The URL within your application that will receive the OAuth 2.0 credentials After you click "Save", Smartsheet assigns a client Id and secret to your app. Make a note of these Ids for the next steps; however, you can always look them up again in "Developer Tools".

Parameters

Parameter Label Required Options Description Help
ClientId ClientId YES
ClientSecret ClientSecret YES
Scope Scope YES
Option Value
ADMIN_SHEETS~ADMIN_SIGHTS~ADMIN_USERS~ADMIN_WEBHOOKS~ADMIN_WORKSPACES~CREATE_SHEETS~CREATE_SIGHTS~DELETE_SHEETS~DELETE_SIGHTS~READ_CONTACTS~READ_EVENTS~READ_SHEETS~READ_SIGHTS~READ_USERS~SHARE_SHEETS~SHARE_SIGHTS~WRITE_SHEETS ADMIN_SHEETS~ADMIN_SIGHTS~ADMIN_USERS~ADMIN_WEBHOOKS~ADMIN_WORKSPACES~CREATE_SHEETS~CREATE_SIGHTS~DELETE_SHEETS~DELETE_SIGHTS~READ_CONTACTS~READ_EVENTS~READ_SHEETS~READ_SIGHTS~READ_USERS~SHARE_SHEETS~SHARE_SIGHTS~WRITE_SHEETS
Scopes you want to work with. API Help
RetryMode RetryMode NO
Option Value
None None
RetryAny RetryAny
RetryWhenStatusCodeMatch RetryWhenStatusCodeMatch
RetryStatusCodeList RetryStatusCodeList NO
RetryCountMax RetryCountMax NO
RetryMultiplyWaitTime RetryMultiplyWaitTime NO