Skip to main content
All CollectionsActions SDK
Authenticate Actions in Jira
Authenticate Actions in Jira

Instructions for how to authenticate Actions built using Glean's Jira template

Cindy Chang avatar
Written by Cindy Chang
Updated over a week ago

In order to setup OAuth for your Jira Action, please follow these steps:

1) Create and Configure the Jira OAuth app

Step 1: Create the app

  • Navigate to the Atlassian Developer Console at this link and create a new app of type: OAuth2.0 Integration.

  • Follow the prompts to set up the app. Make note of details like the app name, description, and logo.

Step 2: Configure the callback URL

  • Go to the Authorization tab of your app configuration.

  • Set the callback URL to the following: https://{domain}-be.glean.com/tools/oauth/verify_code/{uniqueIdentifier}.

    Here the uniqueIdentifier is the unique identifier of the Action you have just created on Glean, you can find it on Glean's Action creation page

Step 3: Set permissions

  • Go to the Permissions tab of your app configuration.

  • Add the following scopes:

    • Jira API - write:jira-work, read:jira-user

2) Fill Authentication section on Glean

Step 1: Select Authentication Type:

There are 2 types of authentication options available for you to choose from:

  1. OAuth Admin - Admin's credentials will be used to perform any action.

  2. OAuth User - Each user's own credentials will be used to perform an action

  • If OAuth Admin is being used, all actions will be taken using Admin's credentials. For this, it is essential that the Admin's account has Modify reporter permissions in Jira for all the Jira projects you want to perform any action in (like creating tickets, adding comments, etc.)

To grant Modify reporter permissions to this Admin, please follow these steps:

  1. Log into Jira with the Admin account (whose credentials you want to use for OAuth Admin)

  2. In Jira’s settings page, click the Issues menu.

  3. Scroll down and select the “Permission schemes” menu and select the permission schemes corresponding to all the projects you want to use for Actions.

  4. Add the user to ‘Modify Reporter’ permissions by clicking ‘Update’ > ‘Single user’ > Select the admin user (whose credentials you want to use for OAuth Admin) > Update

Note: Please ensure the admin user (whose credentials you want to use for OAuth Admin) has the Modify reporter permissions for all the projects you want to perform any action in. Apart from Modify reporter, the admin user also needs to have permissions to 'Create Issues' and 'Assign Issues' for all the projects. This should generally be available by default, but in case it is not, please follow the same steps as Modify reporter above, to assign 'Create Issues' and 'Assign Issues' permissions to the admin user.

  • If OAuth User is being used, each user's own credentials will be used to perform an action. For this, the distribution settings of your Jira OAuth app need to be updated, please follow these steps in order to do this:

  1. Go to the Distribution tab of your app configuration in the Atlassian Developer Console.

  2. Click on Edit.

  3. Change the Distribution Status to 'Sharing'

  4. Add a Privacy policy, you could use this one - https://www.glean.com/privacy-policy

  5. Click on Save Changes.

Step 2: Fill the following fields:

  • Client ID: Retrieve this from the Settings tab of your app configuration in the Atlassian Developer Console.

  • Client secret: Retrieve this from the Settings tab of your app configuration in the Atlassian Developer Console.

Step 3: Complete Setup:

  • Save the Action

  • Once you save the action, a link will appear under Authorization Link.

  • Click on the authorization link provided to complete the OAuth flow.

  • Once authorization is complete, you should see a message “Authorized <action name>”

Did this answer your question?