Dropbox Authenticate an Element Instance

On this page

You can authenticate with Dropbox to create your own instance of the Dropbox element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the Dropbox platform.

Authenticate Through the UI

Use the UI to authenticate with Dropbox and create an element instance. Because you authenticate with Dropbox via OAuth 2.0, all you need to do is add a name for the instance. After you create the instance, you'll log in to Dropbox to authorize Cloud Elements access to your account. For more information about authenticating an element instance, see Authenticate an Element Instance (UI)

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is a multi-step process that involves:


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Getting a Redirect URL


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Use the following API call to request a redirect URL where the user can authenticate with the vendor. Replace {keyOrId} with the element key, dropbox.

GET /elements/{keyOrId}/oauth/url?apiKey=<api_key>&apiSecret=<api_secret>&callbackUrl=<url>&siteAddress=<url>

Query Parameters

Query ParameterDescription
apiKeyThe key obtained from registering your app with the provider. This is the App key that you recorded in API Provider Setup.
apiSecretThe client secret obtained from registering your app with the provider. This is the App secret that you recorded in API Provider Setup.
callbackUrlThe URL that will receive the code from the vendor to be used to create an element instance. This is the Redirect URI that you recorded in API Provider Setup.

Example cURL

curl -X GET
-H 'Content-Type: application/json'
'https://api.cloud-elements.com/elements/api-v2/elements/dropbox/oauth/url?apiKey=fake_api_key&apiSecret=fake_api_secret&callbackUrl=https://www.mycoolapp.com/auth&state=dropbox'

Example Response

Use the oauthUrl in the response to allow users to authenticate with the vendor.

{
"element": "dropbox",
"oauthUrl": "https://www.dropboxbusiness.com/api/oauth2/authorize?response_type=code&client_id=insert_dropbox_client_id0&redirect_uri=https://www.mycoolapp.com/auth&state=dropboxbusiness"
}

Authenticating users and receiving the authorization grant code


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Provide the response from the previous step to the users. After they authenticate, Dropbox provides the following information in the response:

  • code
  • state
Response ParameterDescription
codeThe Authorization Grant Code required by Cloud Elements to retrieve the OAuth access and refresh tokens from the endpoint.
stateA customizable identifier, typically the element key (dropbox) .
Note: If the user denies authentication and/or authorization, there will be a query string parameter called error instead of the code parameter. In this case, your application can handle the error gracefully.

Authenticating the Element Instance


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Use the /instances endpoint to authenticate with Dropbox and create an element instance. If you are configuring events, see Dropbox Events.

Note: The endpoint returns an element id and token upon successful completion. Retain the token and id for all subsequent requests involving this element instance.

To create an element instance:

  1. Construct a JSON body as shown below (see Parameters):

            {
              "element": {
                "key": "dropbox"
              },
              "providerData": {
                "code": "<AUTHORIZATION_GRANT_CODE>"
              },
              "configuration": {
                "oauth.api.key": "<CLIENT_ID>",
                "oauth.api.secret": "<CLIENT_SECRET>",
                "oauth.callback.url": "https://www.mycoolapp.com/auth"
              },
              "tags": [
                "<ADD_YOUR_TAGS>"
              ],
              "name": "<INSTANCE_NAME>"
            }
    
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    
    Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Note the Token and ID and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
    "element": {
      "key": "dropbox"
    },
    "providerData": {
      "code": "8aa74ff8ae16ba3ca19d12cbdea83aff16bddcd7"
    },
    "configuration": {
      "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
      "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxx",
      "oauth.callback.url": "https://mycoolapp.com/auth"
    },
    "tags": [
      "Test"
    ],
    "name": "API Instance"
  }'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Note: Event related parameters are described in Events.
ParameterDescriptionData Type
'key'The element key.
dropbox
string
Name
name
The name for the element instance created during authentication.Body
oauth.callback.urlThe Callback URL for the connected app you created for Dropbox. This is the Redirect URI that you recorded in API Provider Setup.
oauth.api.keyThe key obtained from registering your app with the provider. This is the App key that you recorded in API Provider Setup.string
oauth.api.secretThe client secret obtained from registering your app with the provider. This is the App secret that you recorded in API Provider Setup.string
tagsOptional. User-defined tags to further identify the instance.string

Example Response for an Authenticated Element Instance

{
  "id": 58992,
  "name": "API Instance",
  "createdDate": "2017-08-03T14:41:52Z",
  "token": "5MOxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
      "id": 14,
      "name": "Dropbox",
      "key": "dropbox",
      "description": "Add a Dropbox Instance to connect your existing Dropbox account to the Cloud Storage and Documents Hub, allowing you to manage files and folders. You will need your Dropbox account information to add an instance.",
      "image": "elements/provider_dropbox.png",
      "active": true,
      "deleted": false,
      "typeOauth": true,
      "trialAccount": false,
      "configDescription": "If you do not have an Dropbox account, you can create one at <a href=\"http://www.dropbox.com\" target=\"_blank\">Dropbox Signup</a>",
      "signupURL": "http://www.dropbox.com",
      "transformationsEnabled": false,
      "bulkDownloadEnabled": false,
      "bulkUploadEnabled": false,
      "cloneable": false,
      "extendable": false,
      "beta": false,
      "authentication": {
        "type": "oauth2"
      },
      "extended": false,
      "hub": "documents",
      "protocolType": "http",
      "parameters": [  ],
      "private": false
    },
    "provisionInteractions": [  ],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "configuration": {  },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 12345
    }
  }