Adding Jira repository using OAuth

Refer to the sections below to set up your Jira instance for OAuth connection and authorize Syndeia to use it.

OAuth Setup

Your Jira admin should follow the directions in the links below to add Syndeia as an OAuth consumer to your Jira repository. Note that this needs to be done only once by your Jira admin.

• Jira Server Instance

• Jira Cloud Instance

1. Follow instructions under 'Generate an RSA public/private key pair' to generate the public and private keys:

   1. Your Jira admin will use the jira_publickey.pem file for step 2 below

   2. Your Jira admin will provide all Syndeia users with the jira_privatekey.pcks8 file for authorization

2. Follow directions in the section ‘Create an application link’ / 'Configure the client app as a consumer in Jira, using application links'

   1. Use Consumer key = Syndeia_OAuth_Key or other unique Consumer key of your choice: your Jira admin should provide this to Syndeia users along with the private key file for authorization

   2. Use Consumer name = Syndeia (instead of Example Jira app)

   3. Public key = Copy the public key from the jira_publickey.pem file generated previously and paste it into this field (remove the BEGIN and END lines)

Authorize Jira with Syndeia

As a Syndeia user, follow the steps below to connect to a Jira repository with an OAuth connection.

Open

1. Select OAuth from the dropdown menu

2. Enter the Consumer key chosen in step 2a of OAuth setup: suggested value Syndeia_OAuth_Key is entered by default

3. Enter the contents of the jira_privatekey.pcks8 file under Private Key (remove the BEGIN and END lines). This should have been provided to you by your Jira admin.

4. Click Authorize and you will be taken to the browser to authorize Syndeia

   Open

   

5. Click Allow and then copy the verification code provided into the Verification Code field in the Syndeia Repository Creation dialog shown above.