Confluence

[vivek-appsmith]

🎯 Objective

Set up an Atlassian Confluence OAuth 2.0 application to allow users to authenticate and integrate their Confluence accounts with our app. We'll obtain the Client ID and Client Secret required for the OAuth 2.0 authorization flow.

---

✅ Step-by-Step Instructions

1. Go to Atlassian Developer Console

Visit: https://developer.atlassian.com/console
Log in with your Atlassian account.

---

2. Create a New App

• Click "Create app"
• Select "OAuth 2.0 integration"
• Fill in:
  • App Name (e.g., My Confluence Integration)
  • (Optional) App Description
  • Select a Workspace

Click Create.

---

3. Configure OAuth 2.0

• Go to the "Authorization" tab
• Enable OAuth 2.0 (3LO) if not already enabled
• Set the Redirect URI to:

  https://yourapp.com/oauth/callback
  

• Add any additional redirect URIs if necessary

---

4. Add Required Scopes

Go to the "Permissions" or "Authorization > Scopes" section and add the required scopes:

Common Confluence scopes:

• read:confluence-content.all
• write:confluence-content
• read:confluence-space.summary
• read:confluence-user

📚 Full list of scopes: https://developer.atlassian.com/cloud/confluence/oauth-2-jwt/#scopes

---

5. Save and Retrieve Credentials

• Return to the Authorization tab
• Copy the Client ID and Client Secret
• Store them securely (e.g., environment variables)

---

6. Implement OAuth 2.0 Authorization Code Flow

Authorization URL:

https://auth.atlassian.com/authorize?
  audience=api.atlassian.com&
  client_id=YOUR_CLIENT_ID&
  scope=YOUR_SCOPES&
  redirect_uri=YOUR_CALLBACK_URL&
  state=SOME_STATE&
  response_type=code&
  prompt=consent

Token Exchange Endpoint:

POST https://auth.atlassian.com/oauth/token
Content-Type: application/json

{
  "grant_type": "authorization_code",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "code": "AUTH_CODE_FROM_CALLBACK",
  "redirect_uri": "YOUR_CALLBACK_URL"
}

---

7. Get Cloud ID and Call Confluence APIs

Get Cloud ID:

GET https://api.atlassian.com/oauth/token/accessible-resources
Authorization: Bearer ACCESS_TOKEN

Use Confluence API:

GET https://api.atlassian.com/ex/confluence/{cloudid}/wiki/rest/api/...
Authorization: Bearer ACCESS_TOKEN

---

✅ Outcome

• App registered in Atlassian Developer Console
• OAuth 2.0 enabled with correct redirect URI and scopes
• Client ID and Secret acquired and stored securely
• Ready to implement the OAuth integration in the app

[vivek-appsmith]

https://developer.atlassian.com/console/myapps/ff444f43-8597-4aaf-8f21-d0a13722c119/authorization/auth-code-grant

Created with [email protected] account

[vivek-appsmith]