docs: separate authentication methods in Confluence guide#369
docs: separate authentication methods in Confluence guide#369
Conversation
- Add two distinct authentication methods: Classic API Token and Scoped API Key - Add Cloud ID retrieval instructions with API method - Document required OAuth 2.0 scopes for Confluence API operations - Include scopes for spaces, content, pages, and file operations - Add useful links section with Atlassian documentation references Co-authored-by: Max Strivens <mstrivens@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the Confluence connection guide to clarify and expand authentication guidance, specifically distinguishing classic API-token auth from OAuth-based scoped authentication, in response to #367.
Changes:
- Split Confluence setup into two authentication methods (Classic API Token vs. Scoped OAuth).
- Added Cloud ID retrieval instructions (UI + API).
- Documented required OAuth 2.0 scopes and added OAuth app creation steps plus reference links.
Comments suppressed due to low confidence (1)
connection-guides/documents/confluence.mdx:100
- Terminology is inconsistent and nonstandard: this guide uses
UserName/Email, but other connection guides consistently useUsername(e.g.,connection-guides/iam/checkmk.mdx:28,connection-guides/hris/fourth.mdx:26). Consider renaming this heading/body/bullet toUsername/Email(or justEmail) for consistency and readability.
### Find your UserName/Email
Your UserName/Email can be found at your profile in the upper right-hand corner of the screen.
### Linking your Account with Classic API Token
Upon reaching the Link Account page, select Confluence integration from hub and enter the credentials from the previous steps:
- **UserName/Email**
- **API Token**
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Authentication Method 2: Scoped API Key | ||
|
|
||
| Scoped API Keys use OAuth 2.0 authentication with granular permissions, providing better security by limiting access to only the specific operations your integration needs. | ||
|
|
There was a problem hiding this comment.
The document mixes singular and plural for this auth option (heading says “Scoped API Key”, but the next paragraph starts “Scoped API Keys use…”). Please make the naming consistent throughout (either singular everywhere or plural everywhere).
| Alternatively, you can retrieve your Cloud ID using the API: | ||
| ```bash | ||
| curl -X GET 'https://api.atlassian.com/oauth/token/accessible-resources' \ | ||
| -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| ``` | ||
| </Step> |
There was a problem hiding this comment.
The “retrieve Cloud ID using the API” example requires an OAuth access token, but the guide doesn’t explain where YOUR_ACCESS_TOKEN comes from (or link to Atlassian’s 3LO token/authorization flow). Add a short note or link so readers can actually obtain the bearer token before calling accessible-resources.
| If you've been directed to StackOne to integrate with Confluence, the following steps will help you understand the process and any necessary actions to configure a successful integration. | ||
|
|
||
| Confluence supports two authentication methods: | ||
| - **Classic API Token**: Uses basic authentication with username and API token |
There was a problem hiding this comment.
In the auth-method summary, Classic API Token is described as using a “username and API token”, but later the required field is “UserName/Email”. Consider aligning the wording here with the actual credential users will enter (typically Atlassian account email) to avoid confusion.
| - **Classic API Token**: Uses basic authentication with username and API token | |
| - **Classic API Token**: Uses basic authentication with your Atlassian account email and an API token |
|
Static Code Review 📊 ✅ All quality checks passed! |
![typo-app[bot]](https://avatars.githubusercontent.com/in/360763?s=60&v=4){kind=small}
1 participant
Added two distinct authentication methods for Confluence integration:
Changes:
OAuth Scopes Covered:
Fixes #367
Generated with Claude Code
Summary by cubic
Separated Confluence authentication into two paths (Classic API Token and Scoped API Key) and expanded the guide with Cloud ID, OAuth scopes, and app setup. Addresses Linear issue #367 by clarifying setup and improving security guidance.
Written for commit ec640b9. Summary will update on new commits.
PR Summary by Typo
Overview
This PR updates the Confluence integration guide to clearly separate and detail two distinct authentication methods: Classic API Token and Scoped API Key. This enhancement provides users with comprehensive instructions for both approaches, improving clarity and security guidance.
Key Changes
Work Breakdown
Linked JIRA Issues
No issues found.
To turn off PR summary, please visit Notification settings.