docs: add OAuth scopes documentation to Confluence guide#368
Closed
docs: add OAuth scopes documentation to Confluence guide#368
Conversation
Added comprehensive OAuth 2.0 scope information for Confluence API integration: - read:space:confluence for accessing spaces - read:content:confluence for content search and export operations - read:page:confluence for accessing pages - read:attachment:confluence and write:attachment:confluence for file operations Includes reference link to Atlassian's OAuth scopes documentation. Fixes #367 Co-authored-by: Max Strivens <mstrivens@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive OAuth 2.0 scope documentation to the Confluence integration guide in response to issue #367. The documentation specifies which OAuth scopes are required for different Confluence API operations.
Changes:
- Added a Note section documenting required OAuth 2.0 scopes for Confluence API integration
- Listed five specific scopes with their corresponding API endpoints and operations
- Added a "Useful Links" section with reference to Atlassian's OAuth scopes documentation
- Cleaned up trailing whitespace on several lines
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+44
to
+54
| <Note> | ||
| **API Token Scopes:** If you're using OAuth 2.0 (3LO) or creating a scoped API token, ensure the following scopes are granted for full integration functionality: | ||
|
|
||
| - `read:space:confluence` - Required for accessing spaces (/api/v2/spaces) | ||
| - `read:content:confluence` - Required for content search (/rest/api/content/search) and export operations | ||
| - `read:page:confluence` - Required for accessing pages (/api/v2/pages) | ||
| - `read:attachment:confluence` - Required for downloading files | ||
| - `write:attachment:confluence` - Required for uploading files | ||
|
|
||
| For more information on Confluence OAuth scopes, see [Confluence OAuth Scopes Documentation](https://developer.atlassian.com/cloud/confluence/scopes-for-oauth-2-3LO-and-forge-apps/). | ||
| </Note> |
There was a problem hiding this comment.
The OAuth scope information in this note may be confusing in the context of "Classic API token" creation. Classic API tokens (created in the steps that follow on line 74) do not use OAuth scopes - they have full access to all resources the user has permissions for. OAuth scopes only apply to OAuth 2.0 (3LO) apps or Forge apps, not Classic API tokens.
Consider one of the following approaches:
- Move this note to a separate section specifically for OAuth 2.0 implementations, making it clear that these scopes don't apply to Classic API tokens
- Add clarification within the note that Classic API tokens (described in the following steps) do not require scope configuration and have full access
- If the guide is intended to support both Classic API tokens and OAuth flows, consider splitting into separate sections or providing alternative authentication paths
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added comprehensive OAuth 2.0 scope information for Confluence API integration:
Includes reference link to Atlassian's OAuth scopes documentation.
Fixes #367
Generated with Claude Code
Summary by cubic
Added OAuth 2.0 scope requirements to the Confluence integration guide and a link to Atlassian’s docs. This clarifies the exact permissions needed for spaces, pages, content search, and attachments to prevent setup issues.
Written for commit ae3fe10. Summary will update on new commits.