Jira Connector
Documentation
Version: 11
Documentation
Home » API Integration Hub » Jira Connector » Authentication - OAuth (**Must change API Base URL to V3 OAuth**)

Authentication OAuth (**Must change API Base URL to V3 OAuth**)

Description

OAuth App must be created in Atlassian Developer Console. It is found at https://developer.atlassian.com/console/myapps/ [API reference]

Instructions

Firstly, login into your Atlassian account and then create Jira application:

  1. Go to Atlassian Developer area.
  2. Click Create and select OAuth 2.0 integration item to create an OAuth app: Create OAuth integration app in Atlassian
  3. Give your app a name, accept the terms and hit Create: Name OAuth app in Atlassian
  4. To enable permissions/scopes for your application, click Permissions tab, then hit Add button, and click Configure button, once it appears: Enable scopes in OAuth app in Atlassian
  5. Continue by hitting Edit Scopes button to assign scopes for the application: Edit scopes in OAuth app in Atlassian
  6. Select these scopes or all of them: Add Jira scopes in OAuth app in Atlassian
  7. Then click Authorization option on the left and click Add button: Add authorization in OAuth app in Atlassian
  8. Enter your own Callback URL (Redirect URL) or simply enter https://zappysys.com/oauth, if you don't have one:
    9. Set callback URL for OAuth app in Atlassian
  9. Then hit Settings option and copy Client ID and Secret into your favorite text editor (we will need them in the next step): Get Jira data via REST API and OAuth
  10. Now go to SSIS package or ODBC data source and in OAuth authentication set these parameters:
  • For ClientId parameter use Client ID value from the previous steps.
  • For ClientSecret parameter use Secret value from the previous steps.
  • For Scope parameter use the Scopes you set previously (specify them all here):
    • offline_access (a must)
    • read:jira-user
    • read:jira-work
    • write:jira-work
    • manage:jira-project
    • manage:jira-configuration
    NOTE: A full list of available scopes is available in Atlassian documentation.
  • For Subdomain parameter use your Atlassian subdomain value (e.g. mycompany, if full host name is mycompany.atlassian.net).
  • Click Generate Token to generate tokens.
  • Finally, select Organization Id from the drop down.
  • That's it! You can now use Jira Connector!

    • Parameters

    Parameter Label Required Default value Options Description
    ClientId ClientId YES
    ClientSecret ClientSecret YES
    Scope Scope YES offline_access~read:jira-user~read:jira-work~write:jira-work~manage:jira-project~manage:jira-configuration
    Name Value
    offline_access offline_access
    read:jira-user read:jira-user
    read:jira-work read:jira-work
    write:jira-work write:jira-work
    manage:jira-project manage:jira-project
    manage:jira-configuration manage:jira-configuration
    manage:jira-webhook manage:jira-webhook
    		Permissions you want to use.
    ReturnUrl ReturnUrl YES https://zappysys.com/oauth
    OrganizationId Organization Id (Select after clicking [Generate Token]) YES Your company's Alphanumeric ID (e.g. c66xxx-xxx-xxx). This is obtained by calling GET
    CustomColumnsRegex Custom Columns for output (Select after clicking [Generate Token]) Enter regular expression for custom columns which you like to output. Use Pipe to type multiple column names (must use key - internal names for columns e.g. customfield_10004). You can use Regex too (e.g. field_100\d+ ). This filter is only applied for those fields which has flag custom=true.