diff --git a/src/content/docs/docs/integrations/atlassian-integration.mdx b/src/content/docs/docs/integrations/atlassian-integration.mdx index 3ff674a8..9acc4b0c 100644 --- a/src/content/docs/docs/integrations/atlassian-integration.mdx +++ b/src/content/docs/docs/integrations/atlassian-integration.mdx @@ -45,6 +45,47 @@ Promptless supports two types of Jira integrations depending on your Jira deploy Jira Data Center is in Beta. Please contact the Promptless team at [help@gopromptless.ai](mailto:help@gopromptless.ai) to connect your Jira Data Center instance to Promptless. +## Permissions Required + +The OAuth consent screen displays the permissions Promptless requests when you connect Atlassian. Promptless requests only the scopes needed to read Jira issues and Confluence pages for documentation context. + +### Jira Scopes + +| Scope | Purpose | +|-------|---------| +| `read:jira-work` | Read Jira issues, projects, and work data | +| `write:jira-work` | Required by Atlassian for API access; Promptless uses read-only operations | +| `read:jira-user` | Read user information for issue context | + +### Confluence Scopes + +| Scope | Purpose | +|-------|---------| +| `read:confluence-space.summary` | Read space names and metadata | +| `read:confluence-content.all` | Read page content for documentation context | +| `read:space:confluence` | Read space information (granular scope) | +| `read:page:confluence` | Read individual pages (granular scope) | +| `read:content:confluence` | Read content body (granular scope) | + +### Additional Scopes + +| Scope | Purpose | +|-------|---------| +| `offline_access` | Allow Promptless to refresh tokens without re-authentication | + + +Confluence scopes include both classic and granular variants for compatibility with Atlassian's API v2. Promptless only reads issue and page data—it does not write to Jira or Confluence. The `write:jira-work` scope is required by Atlassian's OAuth system for certain read operations. + + +### Service Account Permissions + +When creating a dedicated Atlassian account for Promptless, the account needs: + +1. **Jira access**: The "User" role (not "User access admin") on projects you want Promptless to reference +2. **Confluence access**: "Can view" permission on spaces you want Promptless to search + +The account does not need administrative permissions. See [Provisioning an Atlassian Account for Promptless](#provisioning-an-atlassian-account-for-promptless) for step-by-step instructions. + ## Jira Cloud Installation For Atlassian Cloud-hosted Jira instances: