Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 3.88 KB

JIRA-README.md

File metadata and controls

81 lines (59 loc) · 3.88 KB

Jira OAuth 2.0 Integration Guide for Specif AI

This guide explains how to integrate the Specif AI solution with Jira using OAuth 2.0. Follow these steps to create an OAuth app, configure permissions, and set up the integration.

Step 1: Create an OAuth 2.0 Integration

  1. Access the Atlassian Developer Console:

    • Open a web browser and navigate to the Atlassian Developer Console.
    • Sign up with Atlassian credentials if you haven't created an account yet.

  2. Create a New OAuth App:

    • Log in and click the Create New App button.
    • Select OAuth 2.0 Integration from the options.
    • Enter a name for the app, such as "Specif AI Integration."
    • Click Create App to proceed.

  3. Navigate to the App Configuration:

    • After creating the app, access the configuration page for the new OAuth app.

Step 2: Configure Permissions for the App

  1. Access the Permissions Tab:

    • Open the Permissions tab in the app's configuration screen to define the APIs accessible by the app.

  2. Add the Required APIs:

    • Under the Permissions section, click Add APIs and select the following:
      • User Identity API: Identifies users interacting with the app.
      • Jira API: Grants access to Jira.

  3. Configure Classic Scopes for Jira API:

    • After adding the Jira API, click Edit Scopes under the Jira API section to set the level of access.
    • Add the following scopes:
      • read:jira-work: Allows reading Jira project and issue information.
      • read:jira-user: Enables reading Jira user information.
      • write:jira-work: Provides write access to Jira issues, such as creating or updating tasks.
    • Save the changes.

Step 3: Configure Authorization

  1. Go to the Authorization Tab:

    • Open the Authorization tab in the app configuration screen.

  2. Select OAuth 2.0 Authorization:

    • Choose OAuth 2.0 as the authorization type to enable OAuth-based authentication between Jira and the Specif AI.

  3. Set the Callback URL:

    • Enter the Callback URL for the Requirements app. This URL is where users will be redirected after authorizing the app.
      • Expected default value : http://localhost:49153/callback

      Note: If you modify the port value, replace it with your app's actual callback URL, updating the port accordingly.

    • Click Save to apply the configuration.

Step 4: Retrieve OAuth Credentials

  1. Go to the Settings Tab:

    • Open the Settings tab in the app configuration screen.

  2. Copy the Client ID and Client Secret:

    • Locate the Client ID and Client Secret:
      • Client ID: Serves as a unique identifier for the app.
      • Client Secret: Used for authentication. Store it securely.
    • Keep both credentials safe, as they are required for OAuth authentication in the Requirements app.

Step 5: Set Up the Integration in the Electron App

  1. Open the Solution Page:

    • Launch the Requirements app and navigate to the Solution -> Integration page.

  2. Enter the OAuth Credentials:

    • Provide the following information in the Jira Integration section:
      • Client ID: Enter the unique identifier from the Atlassian Developer Console.
      • Client Secret: Enter the secret from the console.
      • Project Key: Specify the Jira project for integration. The key can be found on the Jira project settings page.
      • Callback URL: Enter the URL specified during the authorization setup.

  3. Verify the Details:

    • Ensure that the Client ID, Client Secret, and Callback URL match the information entered in the Atlassian Developer Console.
    • Confirm that the Project Key is correct, as it identifies the Jira project that the app will interact with.

By following these steps, you can successfully integrate the Requirements app with Jira using OAuth 2.0.