Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can connect to Jira either by using OAuth (default) or basic-auth.

Note

Keep in mind that basic-auth is not supported on Jira cloud.For Jira cloud: You'll need to generate an API key and use it instead of your password: https://id.atlassian.com/manage-profile/security/api-tokens

.

Tip

In either case, connecting via basic auth or OAuth, we recommend to create a service user upfront.

WHY
Changes made in Jira via piplanning app will be done by the user which was used to setup the connection. That means, every change in the Issue history will be done by that user. Therefore we suggest to use a service user (i.e. piplanning_app) so it's clear which changes are done from the piplanning app.

...

Note

In both cases, using a service user or a normal user, keep in mind that this user has the following permissions in all Jira projects you want to synchronize with the piplanning app:

  • BROWSE_PROJECT
  • CREATE_ISSUES
  • DELETE_ISSUES (optional)
  • EDIT_ISSUES
  • LINK_ISSUES
  • SCHEDULE_ISSUES
  • MANAGE_SPRINTS_PERMISSION (optional)

...

  1. Create a service user (recommendation)
    1. Login to Jira with the service user (make sure the user has the right permissions)
  2. Login to the piplanning app with a piplanning app Admin User who has also the permissions of a Jira Administrator
  3. Fill out the basic connection details. To start the OAuth-dance click "Connect to Jira"

    NameDescription
    Connection nameName for the connection. That is just for the user to give a friendly name.
    Instance URL

    Url to your Jira. Use http or https as schema.


  4. In the OAuth popup, follow the steps mentioned in the video or use instructions from step-by-step guide Setup OAuth for authentication with Jira.

    Info

    The user with which you are logged in to Jira (as mentioned we recommend that to be a service user) while setting up the OAuth connection will be used to to do all the sync-work between Jira and the piplanning-app. Make sure that this user has appropriate permissions.


    Note

    The keys used in the OAuth connection are the same overall Jira connections created by the same piplanning-app company. Those keys are generated at first usage.


Re-Authenticate (i.e. when you want to connect with a service user)

Please follow the steps in the video to re-authenticate with a new user

View file
namejira-re-oauth.mov
height250