Miro

The Miro auth provider enables tools and agents to call Miro APIs  on behalf of a user using OAuth 2.0 authentication.

What’s documented here

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

This auth provider is used by:

• The Arcade Miro MCP Server, which provides pre-built tools for interacting with Miro
• Your app code that needs to call the Miro API
• Or, your custom tools that need to call the Miro API

Configuring Miro auth

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

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

Create a Miro app

To integrate with Miro’s API, you’ll need to create an app in the Miro Developer Platform:

For detailed instructions, refer to Miro’s OAuth documentation .

Next, add the Miro app to Arcade.

Configuring your own Miro Auth Provider in Arcade

export MIRO_CLIENT_ID="<your client ID>"
export MIRO_CLIENT_SECRET="<your client secret>"

MIRO_CLIENT_ID="<your client ID>"
MIRO_CLIENT_SECRET="<your client secret>"

auth:
  providers:
    - id: arcade-miro
      description: Miro OAuth 2.0 provider
      enabled: true
      type: oauth2
      client_id: ${env:MIRO_CLIENT_ID}
      client_secret: ${env:MIRO_CLIENT_SECRET}
      oauth2:
        scope_delimiter: " "
        authorize_request:
          endpoint: "https://miro.com/oauth/authorize"
          params:
            response_type: code
            client_id: "{{client_id}}"
            redirect_uri: "{{redirect_uri}}"
            scope: "{{scopes}}"
            state: "{{state}}"
        token_request:
          endpoint: "https://api.miro.com/v1/oauth/token"
          params:
            grant_type: authorization_code
            client_id: "{{client_id}}"
            client_secret: "{{client_secret}}"
            redirect_uri: "{{redirect_uri}}"
          response_content_type: application/json

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

Using Miro auth in app code

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

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

from arcadepy import Arcade
 
client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
user_id = "{arcade_user_id}"
 
# Start the authorization process
auth_response = client.auth.start(
    user_id=user_id,
    provider="arcade-miro",
    scopes=["boards:read", "boards:write"]
)
 
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...

import { Arcade } from "@arcadeai/arcadejs";
 
const client = new Arcade();
 
const userId = "{arcade_user_id}";
 
// Start the authorization process
const authResponse = await client.auth.start(
  userId,
  "arcade-miro",
  ["boards:read", "boards:write"]
);
 
if (authResponse.status !== "completed") {
  console.log("Please complete the authorization challenge in your browser:");
  console.log(authResponse.url);
}
 
// Wait for the authorization to complete
authResponse = await client.auth.waitForCompletion(authResponse);
 
const token = authResponse.context.token;
// Do something interesting with the token...

Using Miro auth in custom tools

You can use the pre-built Arcade Miro MCP Server to quickly build agents and AI apps that interact with Miro.

If the pre-built tools in the Miro MCP Server don’t meet your needs, you can author your own custom tools that interact with the Miro API.

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

from typing import Annotated
 
import httpx
from arcade_tdk import ToolContext, tool
from arcade_tdk.auth import OAuth2
 
 
@tool(
    requires_auth=OAuth2(
        provider_id="arcade-miro",
        scopes=["boards:read"]
    )
)
async def get_user_boards(
    context: ToolContext,
) -> Annotated[dict, "The user's boards."]:
    """
    Retrieve the list of boards for the authenticated user.
    """
    url = "https://api.miro.com/v2/boards"
    headers = {
        "Authorization": context.authorization.token,
    }
 
    async with httpx.AsyncClient() as client:
        response = await client.get(url, headers=headers)
        response.raise_for_status()
        return dict(response.json())

Available Scopes

Miro supports various OAuth scopes that determine the level of access your application has:

• boards:read - Read board information
• boards:write - Create and modify boards
• team:read - Read team information
• team:write - Manage team settings
• organizations:read - Read organization information
• organizations:teams:read - Read organization teams

For a complete list of available scopes, refer to the Miro Scopes documentation .