HomeCustomizing AuthDiscord

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 as described below.

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

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

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

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

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)

Next, add the Discord 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 Discord Auth Provider in Arcade

There are two ways to configure your Atlassian 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 Discord 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 Discord.

Enter the provider details

  • Choose a unique ID for your provider (e.g. “my-discord-provider”).
  • Optionally enter a Description.
  • Enter the Client ID and Client Secret from your Discord 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 Discord auth using your Arcade account credentials, the Arcade Engine will automatically use this Discord OAuth provider. If you have multiple Discord providers, see using multiple auth providers of the same type for more information.

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 = "user@example.com"
 
# 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

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()
AtlassianDropbox