Discord auth provider

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

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

What’s documented here

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

This auth provider is used by:

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

Configuring Discord auth

At the moment, you can only configure Discord auth with a self-hosted Engine.

Create a Discord app

Create a Discord Application in the Discord developer portal
In the OAuth2 tab, set the redirect URI to: https://cloud.arcade.dev/api/v1/oauth/callback
Copy the Client ID and Client Secret (you may need to reset the secret to see it)

Configuring Discord auth with the Arcade Dashboard

Navigate to the OAuth section of the Arcade Dashboard and click Add OAuth Provider.
Select Discord as the provider.
Choose a unique ID for your provider (e.g. “my-discord-provider”) with an optional Description.
Enter your Client ID and Client Secret from your Discord app.
Click Save.

When you use tools that require Discord auth using your Arcade account credentials, the Arcade Engine will automatically use this Discord OAuth provider.

Configuring Discord auth in self-hosted Arcade Engine configuration

Set environment variables

Set the following environment variables:

export DISCORD_CLIENT_ID="<your client ID>"
export DISCORD_CLIENT_SECRET="<your client secret>"

Or, you can set these values in a .env file:

DISCORD_CLIENT_SECRET="<your client secret>"
DISCORD_CLIENT_ID="<your client ID>"

See Engine configuration for more information on how to set environment variables and configure the Arcade Engine.

Edit the Engine configuration

Edit the engine.yaml file and add a discord item to the auth.providers section:

auth:
  providers:
    - id: default-discord
      description: "The default Discord provider"
      enabled: true
      type: oauth2
      provider_id: discord
      client_id: ${env:DISCORD_CLIENT_ID}
      client_secret: ${env:DISCORD_CLIENT_SECRET}

Using Discord auth in app code

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

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

from arcadepy import Arcade
 
client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
user_id = "[email protected]"
 
# Start the authorization process
auth_response = client.auth.start(
    user_id=user_id,
    provider="discord",
    scopes=["identify", "email", "guilds", "guilds.join"],
)
 
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 Discord auth in custom tools

The Arcade Model API is a convenient way to call language models and automatically invoke tools. You can author your own custom tools that interact with the Discord API.

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

from typing import Annotated, Optional
 
import httpx
 
from arcade.sdk import ToolContext, tool
from arcade.sdk.auth import Discord
 
 
@tool(
    requires_auth=Discord(
        scopes=["guilds"],
    )
)
async def list_servers(
    context: ToolContext,
    user_id: Annotated[
        Optional[str],
        "The user's user ID. Defaults to '@me' for the current user.",
    ] = "@me",
) -> Annotated[dict, "List of servers the user is a member of"]:
    """List a Discord user's servers they are a member of."""
    url = f"https://discord.com/api/users/{user_id}/guilds"
    headers = {"Authorization": f"Bearer {context.authorization.token}"}
 
    async with httpx.AsyncClient() as client:
        response = await client.get(url, headers=headers)
        response.raise_for_status()
        return response.json()

Atlassian Dropbox