Confluence API Token Scopes

[mstrivens]

@claude update the confluence hub guide with additional information on scoped tokens:

https://developer.atlassian.com/cloud/confluence/scopes-for-oauth-2-3LO-and-forge-apps/

Ensure the scopes are relevant for our required requests which are:

/api/v2/spaces
/rest/api/content/search
/api/v2/pages
https://{{bundle.credentials.domain}}.atlassian.net/wiki/';
const exportPath = exportword?pageId={{bundle.input.id}};
const downloadPath = rest/api/content/{{bundle.input.id}}?expand=body.export_view;
upload and ownload operations required for files

[claude]

Claude finished @mstrivens's task —— View job • claude/issue-367-20260205-1710 • Create PR ➔

---

Tasks

• Locate existing Confluence hub guide
• Research Confluence OAuth scopes for required API endpoints
• Update Confluence guide with scope information
• Commit and push changes
• Provide PR creation link

Summary

I've successfully updated the Confluence hub guide with OAuth scope information. The changes include:

Added OAuth Scopes Documentation:

• 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

Additional Updates:

• Added a Note section explaining the required OAuth 2.0 scopes at the beginning of the API token creation section
• Added a "Useful Links" section with a reference to Atlassian's official OAuth scopes documentation
• Mapped all the API endpoints mentioned in the issue to their corresponding OAuth scopes

The scopes cover all the required API endpoints you specified:

• /api/v2/spaces
• /rest/api/content/search
• /api/v2/pages
• Export operations (exportword, body.export_view)
• File upload and download operations

Next Steps

[mstrivens]

@claude update this so that the scoped api keys are a eparate auth type within the confluence hub guide. we will also need to instruct users to retrive the cloud id

https://support.atlassian.com/jira/kb/retrieve-my-atlassian-sites-cloud-id/

[claude]

Claude finished @mstrivens's task —— View job • claude/issue-367-20260206-1122 • Create PR ➔

---

Tasks

• Read existing Confluence hub guide
• Restructure guide to separate OAuth and Scoped API Keys as distinct auth types
• Add Cloud ID retrieval instructions
• Verify all links work properly (using user-provided links)
• Commit and push changes
• Provide PR creation link

Summary

Successfully restructured the Confluence hub guide to include two distinct authentication methods:

1. Classic API Token (Method 1)

• Retained the existing authentication flow with username/email and API token
• Kept all existing steps and screenshots

2. Scoped API Key (Method 2)

• Added new OAuth 2.0 authentication method with granular permission scopes
• Included Cloud ID retrieval instructions with both UI and API methods
• Documented all required OAuth 2.0 scopes:
  • read:space:confluence - For accessing spaces (/api/v2/spaces)
  • read:content:confluence - For content search and export operations
  • read:page:confluence - For accessing pages (/api/v2/pages)
  • read:attachment:confluence - For downloading files
  • write:attachment:confluence - For uploading files
• Added OAuth app creation steps
• Added linking instructions for scoped API keys

Additional Changes

• Added "Useful Links" section with references to:
  • Atlassian's OAuth 2.0 scopes documentation
  • Cloud ID retrieval guide
• Updated section headings to clearly distinguish between authentication methods

--- • claude/issue-367-20260206-1122

[mstrivens]

@claude change this completely. We now don't support scopes api keys - instead we suport oauth service accounts, doce here and sceopes below

https://support.atlassian.com/user-management/docs/create-oauth-2-0-credential-for-service-accounts/

search:confluence
read:confluence-space.summary
read:space:confluence
read:page:confluence
read:content:confluence
write:page:confluence

[claude]

Claude finished @mstrivens's task —— View job • claude/issue-367-20260207-0918 • Create PR ➔

---

Tasks

• Read current Confluence guide
• Read CLAUDE.md documentation standards
• Replace scoped API keys with OAuth service accounts
• Update OAuth scopes list
• Verify documentation link
• Commit and push changes
• Provide PR creation link

---

Summary

I've successfully updated the Confluence guide to replace the Classic API Token authentication method with OAuth 2.0 Service Accounts.

Key Changes:

• Removed Classic API Token authentication method (Steps for creating API tokens, finding username/email)
• Added OAuth 2.0 Service Account authentication with complete setup instructions
• Updated OAuth scopes to match the requirements:
  • search:confluence - Search across Confluence content
  • read:confluence-space.summary - Read space summaries
  • read:space:confluence - Access spaces (/api/v2/spaces)
  • read:page:confluence - Access pages (/api/v2/pages)
  • read:content:confluence - Search and export content (/rest/api/content/search)
  • write:page:confluence - Create and update pages
• Added Useful Links section with references to:
  • OAuth 2.0 credential creation guide
  • Atlassian Developer Console
  • Confluence OAuth 2.0 scopes documentation
• Updated linking instructions to use Client ID and Client Secret instead of Username/Email and API Token

The guide now follows the OAuth service account pattern and includes all the scopes you specified for the required API endpoints.

---

• claude/issue-367-20260207-0918