Installing OAuth Integration App
The Broker uses OAuth 2.0 with 3-legged OAuth (3LO) to authenticate users accessing the broker pages.
This requires creating an OAuth integration app in the Atlassian Developer Console.
Create the OAuth Integration App
- Go to the Atlassian Developer Console.
- Click the Create button on the top-right corner and select OAuth 2.0 integration.
- Enter a name for the application (e.g., OSLC Connect OAuth).
- Accept the Atlassian's developer terms by checking the checkbox.
- Click Create.
Configure Permissions
- On the app page, select Permissions from the left panel.
- Click the Add button for the Jira API row.
- Click the Configure button that appears.
- Click Edit Scopes in the Jira platform REST API section.
- Select the following scopes:
read:jira-work
read:jira-user
write:jira-work
- Click Save.
Configure Authorization Callback
- Select Authorization from the left panel.
- Click the Add button on the right panel.
- In the Callback URL field, add your Broker's callback URL:
https://<your-broker-url>:<port>/oslc-connect-jira/login/access
Replace <your-broker-url> with your Broker's public URL and <port> with the application port (if any).
Example: https://my-broker.example.com/oslc-connect-jira/login/access
- Click Save changes.
Make the OAuth Integration public
The OAuth Integration App need to be shared to allow other users to connect through it.
- Select Distribution from the left panel.
- Click Edit, then fill:
- Vendor: Your-company-name
- Privacy policy: link-to-your-privacy-policy
- Personal Data Declaration: Select No
Retrieve OAuth Credentials
- Select Settings from the left panel.
- In the Authentication details section, locate:
- Client ID
- Secret (click "Show" to reveal)
- Copy these values securely - you will need them for Broker configuration.
Important: Keep the Client Secret secure and never expose it in client-side code or public repositories.
Configuration Reference
The OAuth credentials will be used in the Broker configuration:
| OAuth Value |
Broker Configuration Property |
| Client ID |
jira-cloud.oauth.client.id |
| Secret |
jira-cloud.oauth.client.secret |