Atlassian auth provider

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

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

What’s documented here

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

This auth provider is used by:

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

Configuring Atlassian auth

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

Create a Atlassian app

Create a Atlassian app in the Atlassian developer console
In the Authorization tab, click the “Add” action button and set the Callback URL to: https://cloud.arcade.dev/api/v1/oauth/callback
In the Permissions tab, enable any permissions you need for your app
In the Settings tab, copy the Client ID and Secret to use below

Configuring Atlassian auth with the Arcade Dashboard

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

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

Configuring Atlassian auth in self-hosted Arcade Engine configuration

Set environment variables

Set the following environment variables:

export ATLASSIAN_CLIENT_ID="<your client ID>"
export ATLASSIAN_CLIENT_SECRET="<your client secret>"

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

ATLASSIAN_CLIENT_SECRET="<your client secret>"
ATLASSIAN_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 atlassian item to the auth.providers section:

auth:
  providers:
    - id: default-atlassian
      description: "The default Atlassian provider"
      enabled: true
      type: oauth2
      provider_id: atlassian
      client_id: ${env:ATLASSIAN_CLIENT_ID}
      client_secret: ${env:ATLASSIAN_CLIENT_SECRET}

Using Atlassian auth in app code

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

Use client.auth.start() to get a user token for the Atlassian 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="atlassian",
    scopes=["read:me", "read:jira-user", "read:confluence-user"],
)
 
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 Atlassian 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 Atlassian API.

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

from typing import Annotated, Optional
 
import httpx
 
from arcade.sdk import ToolContext, tool
from arcade.sdk.auth import Atlassian
 
 
@tool(
    requires_auth=Atlassian(
        scopes=["read:jira-work"],
    )
)
async def list_projects(
    context: ToolContext,
    query: Annotated[
        Optional[str],
        "The query to filter the projects by. Defaults to empty string to list all projects.",
    ] = "",
) -> Annotated[dict, "The list of projects in a user's Jira instance"]:
    """List a Jira user's projects."""
    url = f"https://api.atlassian.com/ex/jira/<cloudId>/rest/api/3/project/search?query={query}"
    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()

Overview Discord