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

  1. Go to the Atlassian Developer Console.
  2. Click the Create button on the top-right corner and select OAuth 2.0 integration.
  3. Enter a name for the application (e.g., OSLC Connect OAuth).
  4. Accept the Atlassian's developer terms by checking the checkbox.
  5. Click Create.

Configure Permissions

  1. On the app page, select Permissions from the left panel.
  2. Click the Add button for the Jira API row.
  3. Click the Configure button that appears.
  4. Click Edit Scopes in the Jira platform REST API section.
  5. Select the following scopes:
  6. Click Save.

Configure Authorization Callback

  1. Select Authorization from the left panel.
  2. Click the Add button on the right panel.
  3. 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

  4. Click Save changes.

Make the OAuth Integration public

The OAuth Integration App need to be shared to allow other users to connect through it.

  1. Select Distribution from the left panel.
  2. Click Edit, then fill:

Retrieve OAuth Credentials

  1. Select Settings from the left panel.
  2. In the Authentication details section, locate:
  3. 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