HomeCustomizing AuthDropbox

Dropbox auth provider

At this time, Arcade does not offer a default Dropbox Auth Provider. To use Dropbox auth, you must create a custom Auth Provider with your own Dropbox OAuth 2.0 credentials as described below.

The Dropbox auth provider enables tools and agents to call the Dropbox API on behalf of a user. Behind the scenes, the Arcade Engine and the Dropbox auth provider seamlessly manage Dropbox OAuth 2.0 authorization for your users.

What’s documented here

This page describes how to use and configure Dropbox auth with Arcade.

This auth provider is used by:

  • Your app code that needs to call Dropbox APIs
  • Or, your custom tools that need to call Dropbox APIs

Configuring Dropbox auth

In a production environment, you will most likely want to use your own Dropbox app credentials. This way, your users will see your application’s name requesting permission.

You can use your own Dropbox credentials in both the Arcade Cloud and in a self-hosted Arcade Engine instance.

Before showing how to configure your Dropbox app credentials, let’s go through the steps to create a Dropbox app.

Create a Dropbox app

  • Create a Dropbox Application in the Dropbox App Console
  • In the Settings tab, under the “OAuth 2” section, set the redirect URI to: https://cloud.arcade.dev/api/v1/oauth/callback
  • In the Permissions tab, add any scopes that your app will need
  • In the Settings tab, copy the App key (Client ID) and App secret (Client Secret), which you’ll need below

Next, add the Dropbox app to your Arcade Engine configuration. You can do this in the Arcade Dashboard, or by editing the engine.yaml file directly (for a self-hosted instance).

Configuring your own Dropbox Auth Provider in Arcade

There are two ways to configure your Dropbox app credentials in Arcade:

  1. From the Arcade Dashboard GUI
  2. By editing the engine.yaml file directly (for a self-hosted Arcade Engine)

We show both options step-by-step below.

Configure Dropbox Auth Using the Arcade Dashboard GUI

Access the Arcade Dashboard

To access the Arcade Cloud dashboard, go to api.arcade.dev/dashboard. If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.

Navigate to the OAuth Providers page

  • Under the OAuth section of the Arcade Dashboard left-side menu, click Providers.
  • Click Add OAuth Provider in the top right corner.
  • Select the Included Providers tab at the top.
  • In the Provider dropdown, select Dropbox.

Enter the provider details

  • Choose a unique ID for your provider (e.g. “my-dropbox-provider”).
  • Optionally enter a Description.
  • Enter the Client ID and Client Secret from your Dropbox app.

Create the provider

Hit the Create button and the provider will be ready to be used in the Arcade Engine.

When you use tools that require Dropbox auth using your Arcade account credentials, the Arcade Engine will automatically use this Dropbox OAuth provider. If you have multiple Dropbox providers, see using multiple auth providers of the same type for more information.

Using Dropbox auth in app code

Use the Dropbox auth provider in your own agents and AI apps to get a user-scoped token for the Dropbox API. See authorizing agents with Arcade to understand how this works.

Use client.auth.start() to get a user token for the Dropbox API:

from arcadepy import Arcade
 
client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
user_id = "user@example.com"
 
# Start the authorization process
auth_response = client.auth.start(
    user_id=user_id,
    provider="dropbox",
    scopes=["openid", "sharing.read", "files.metadata.read"],
)
 
if auth_response.status != "completed":
    print("Please complete the authorization challenge in your browser:")
    print(auth_response.url)
 
# Wait for the authorization to complete
auth_response = client.auth.wait_for_completion(auth_response)
 
token = auth_response.context.token
# Do something interesting with the token...

Using Dropbox auth in custom tools

You can author your own custom tools that interact with the Dropbox API.

Use the Dropbox() auth class to specify that a tool requires authorization with Dropbox. The context.authorization.token field will be automatically populated with the user’s Dropbox token:

from typing import Annotated, Optional
 
import httpx
 
from arcade.sdk import ToolContext, tool
from arcade.sdk.auth import Dropbox
 
 
@tool(
    requires_auth=Dropbox(
        scopes=["files.metadata.read"],
    )
)
async def list_files(
    context: ToolContext,
    path: Annotated[
        Optional[str],
        "The path to the folder to list the contents of. Defaults to empty string to list the root folder.",
    ] = "",
) -> Annotated[dict, "List of servers the user is a member of"]:
    """Starts returning the contents of a folder."""
    url = "https://api.dropboxapi.com/2/files/list_folder"
    headers = {"Authorization": f"Bearer {context.authorization.token}"}
 
    async with httpx.AsyncClient() as client:
        response = await client.post(url, headers=headers, json={"path": path})
        response.raise_for_status()
        return response.json()
DiscordGitHub