Dropbox Scope

AutomatR.Dropbox.Activities.DropboxScope

The "Dropbox Scope" activity in AutomatR is designed to set up Dropbox OAuth authentication for a user, allowing subsequent Dropbox activities to be executed securely within the established scope. This activity is essential for obtaining the required access token and client instance to interact with Dropbox services.

Prerequisite

To generate an API key (Refresh Token) for your Dropbox account, follow these steps:

1. Sign in to your Dropbox account at https://www.dropbox.com.

2. Go to the Dropbox App Console by visiting the following URL: https://www.dropbox.com/developers/apps/create.

3. Select the option "Scoped access" and click on the "Create app" button.

4. Provide a name for your app. This can be any name you choose.

5. Choose the type of access you require for your app. For example, if you need access to a user's files, select the "Full dropbox" option.

6. Click on the "Create app" button.

7. On the app's settings page, you will find the "OAuth 2" section. Under the "OAuth 2" section, you will see the generated API key labeled as "App key." This is the Refresh Token you can use to authenticate in the AutomatR application and make API calls to Dropbox.

NOTE: Make sure to keep your Refresh Token secure and do not share it publicly or expose it in your application's source code. Treat it as sensitive information and store it securely.

NOTE: The steps provided are based on the information available up to the cutoff in September 2021. The Dropbox website and interface may have been updated since then, so it's recommended to refer to the official Dropbox documentation for the most up-to-date instructions on generating an API key (Refresh Token) .

Properties

Name	Description
Input
Auth	Enables Dropbox OAuth authentication with options to approve or reject. Allows setting up credentials securely. See the AuthDetails section for details.
Misc
Display Name	The display name of the activity. A display name is automatically generated when you indicate a target.
Optional
Delay	Specifies the amount of time (in seconds) to wait before executing the "Dropbox Scope" activity. Integer variables containing the delay duration. Example: 5 seconds i.e. 5.

AuthDetails

The AuthDetails input property is essential for Dropbox OAuth authentication. It includes the following sub-properties:

• IsCredRegistered (boolean): Indicates whether the credentials are already registered.
• Token (string): The OAuth access token.
• ApprovalUri (string): The approval URI for the user to grant access.

Note: Ensure that you set up the "AuthDetails" property before using the "Dropbox Scope" activity.

How to Use

1. Drag and drop the "Dropbox Scope" activity onto the workflow.
2. Configure the "Auth" property by clicking on it. This enables Dropbox OAuth authentication with the option to approve or reject.
3. Optionally, configure the delay and customize the display name.
4. Execute the workflow to set up the Dropbox OAuth authentication scope.

Example:

Consider an example where the "Dropbox Scope" activity is used to set up OAuth authentication for Dropbox:

Dropbox Scope:
  Display Name: "Authenticate with Dropbox"
  Auth:
    IsCredRegistered: False
    Token: ""
    ApprovalUri: approvalUriVariable
  Delay: 5

In this example, the activity sets up OAuth authentication for Dropbox, and the approval URI is stored in the variable "approvalUriVariable" for further use.

Important Notes:

• The activity must be placed before any other Dropbox activities to establish the authentication scope.
• Ensure that the "AuthDetails" property is correctly configured for proper authentication.

For more information, refer to the Dropbox API documentation.