Creating OAuth App for Atlassian Confluence (User)
Create and configure an Atlassian OAuth 2.0 (3LO) application for Confluence backup and restore operations.
Prerequisites
-
Access to Atlassian Developer Console
-
Global admin privileges for the Confluence site
OAuth App Creation Steps
Step 1: Create New OAuth 2.0 App
-
Log in to the Atlassian Developer Console
-
Click Create and select OAuth 2.0(3LO) app
-
Provide a descriptive name for the app
-
Select Access type as Resource-level
Step 2: Configure Permissions
Configure User Identity API
-
In the left-hand menu, click Permissions
-
Click Add and Configure next to User identity API
-
Click Edit scopes and enable the following scope:
-
read:me -
Click Save
Configure Confluence API
-
Click Add and Configure next to Confluence API
-
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
-
Navigate to Authorization in the left menu
-
Next to OAuth 2.0(3LO), click Add or Configure
-
For Callback URL, paste the redirect URL that you copied from the Commvault backup configuration wizard.
-
Click Save
Step 4: Save OAuth Credentials
-
Navigate to Settings in the left menu
-
Copy and securely store:
-
Client ID (OAuth app ID)
-
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:
-
The Commvault OAuth app is installed on the Atlassian site.
-
The user is redirected to the onboarding page with an authorization code.
-
The authorization code generates a refresh token, which is stored with the authenticated user's information.
-
The refresh token generates access tokens (valid for one hour) for backup, restore, and other operations.
-
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