Creating OAuth App for Atlassian Confluence with Required Scopes (User)

Creating OAuth App for Atlassian Confluence (User)

Create and configure an Atlassian OAuth 2.0 (3LO) application for Confluence backup and restore operations.

Prerequisites

OAuth App Creation Steps

Step 1: Create New OAuth 2.0 App

  1. Log in to the Atlassian Developer Console

  2. Click Create and select OAuth 2.0(3LO) app

  3. Provide a descriptive name for the app

  4. Select Access type as Resource-level

Step 2: Configure Permissions

Configure User Identity API

  1. In the left-hand menu, click Permissions

  2. Click Add and Configure next to User identity API

  3. Click Edit scopes and enable the following scope:

  4. read:me

  5. Click Save

Configure Confluence API

  1. Click Add and Configure next to Confluence API

  2. Enable the following scopes:

Classic Scopes:

  • search:confluence

  • write:confluence-space

  • write:confluence-file

  • readonly:content.attachment:confluence

  • read:confluence-content.summary

  • write:confluence-content

  • read:confluence-user

  • read:confluence-groups

Granular Scopes:

  • read:space:confluence

  • write:space:confluence

  • write:page:confluence

  • read:page:confluence

  • delete:page:confluence

  • write:embed:confluence

  • read:embed:confluence

  • write:folder:confluence

  • read:folder:confluence

  • read:attachment:confluence

  • read:custom-content:confluence

  • write:custom-content:confluence

  • write:comment:confluence

  • read:comment:confluence

  • read:content-details:confluence

  • read:configuration:confluence

  • read:space.permission:confluence

  • write:space.permission:confluence

  • write:configuration:confluence

  • delete:attachment:confluence

  • Click Save

Step 3: Configure Authorization

  1. Navigate to Authorization in the left menu

  2. Next to OAuth 2.0(3LO), click Add or Configure

  3. For Callback URL, paste the redirect URL that you copied from the Commvault backup configuration wizard.

  4. Click Save

Step 4: Save OAuth Credentials

  1. Navigate to Settings in the left menu

  2. Copy and securely store:

  3. Client ID (OAuth app ID)

  4. Client secret (OAuth app secret)

Raise Tier Upgrade Request

Raise a ticket with Atlassian to upgrade the OAuth app from Tier 1 (Global Pool) to Tier 2 (Per-Tenant Pool) for higher API rate limits required for enterprise backup operations.

OAuth Authorization Flow

When a user authorizes the Commvault OAuth app:

  1. The Commvault OAuth app is installed on the Atlassian site.

  2. The user is redirected to the onboarding page with an authorization code.

  3. The authorization code generates a refresh token, which is stored with the authenticated user's information.

  4. The refresh token generates access tokens (valid for one hour) for backup, restore, and other operations.

  5. Access token renewal automatically issues a new refresh token and invalidates the previous token.

Token Management

  • Access Token: Valid for 1 hour, used for all Confluence API operations

  • When a new access token is generated, Atlassian issues a new refresh token and invalidates the previous one

  • App Manager handles centralized access token generation to prevent race conditions

×

Loading...