core-plugin-api package comes with an Atlassian authentication
provider that can authenticate users using Atlassian products. This auth
only provides scopes for the following APIs:
- Confluence API
- User REST API
- Jira platform REST API
- Jira Service Desk API
- Personal data reporting API
- User identity API
Create an OAuth 2.0 (3LO) app in the Atlassian developer console
To add Atlassian authentication, you must create an OAuth 2.0 (3LO) app.
Click on the drop down
Create, and choose
OAuth 2.0 integration.
Name your integration and click on the
Settings for local development:
- Callback URL:
- Use rotating refresh tokens
- For permissions, you must enable
View user profilefor the currently logged-in user, under
User identity API
The provider configuration can then be added to your
app-config.yaml under the
The Atlassian provider is a structure with three configuration keys:
clientId: The Key you generated in the developer console.
clientSecret: The Secret tied to the generated Key.
scopes: List of scopes the app has permissions for, separated by spaces.
NOTE: the scopes
read:me are provided by default.
Adding the provider to the Backstage frontend
To add the provider to the frontend, add the
atlassianAuthApi reference and
SignInPage component as shown in
Adding the provider to the sign-in page.