Configure Basic (cookie-based) Connection

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-administration-guides/system-setup/jira-integration/setting-up-jira-integration/configure-basic--cookie-based--connection.html

Basic authentication can only be used for Jira Server integration. This authentication type is not applicable for connections to Jira Cloud. Another possible authentication type for Jira Server is OAuth.

Basic authentication is also called cookie-based in Zephyr UI.

Requirements

To connect to Jira Server, you will have to specify a Jira user account. If webhooks will be created automatically, this account must have the following permissions:

  • Browse Project permissions for all projects

  • Issue Permissions: Assignable User, Assign Issues, Close Issues, Delete Issues, Edit Issues, Link Issues, Move Issues, Set Issue Security, Transition Issues

  • Comments Permissions

  • Attachment Permissions

  • Jira Web-hook Enabled

  • Issues Related Events: Updated, Deleted

  • Project Version Related Events: Released, Unreleased, Created, Moved, Updated, Deleted

  • Project Related Events: Updated, Deleted

Before configuring the connection, log in to Jira and check the permissions there. If needed, ask you Jira administrator for assistance.

We recommend that you create a special user account for integration with your Jira instance and assign all the needed permissions to it.

 Create a Jira connection using the Basic authentication

  1. Log in to your Zephyr Enterprise instance as a user with administrator permissions.

  2. Go to Administration > (System Setup) Jira Integration.

  3. Click + above the Jira instance list:

     

  4. In the subsequent dialog, specify the following values:


    - Auth mode -Select Basic (cookie-based).
    - Name – Any descriptive name for the connection. It will be used in the Zephyr UI.
    - Jira URL – The URL and port number of your Jira server.
    - Username and Password – The name and password of the account that Zephyr will use to communicate with Jira.

    Click Confirm to continue.

  5. Click Continue in the subsequent confirmation dialog:

     

  6. Zephyr will run some diagnostics and will report the results:


    Click Done. You will see the newly created connection in the list of connections:

Further steps

You have not yet completed integration setup. To complete it, you need to map your Zephyr project to a Jira project. Follow this link for details:

Next step: Configure your Zephyr project

Note about webhooks

Webhooks are an essential part of Zephyr integration with Jira. They are used to synchronize Zephyr and Jira requirements and information about defects.

Webhooks can be created in two ways:

  • Zephyr creates a pre-configured webhook automatically when you are mapping a project in Zephyr. In this case, there is no need to perform any additional actions, but you need to have a Jira account with special permissions (for example, Browse Projects). You can view the created webhook in Jira settings: go to > System (under Jira Settings) > Webhooks (under Advanced).

    Don’t delete this webhook, and don’t change its properties. It has all the needed settings enabled. Later, you can update the webhook, if needed.

  • You, as an administrator, can create and manage webhooks manually. This can be useful if you do not have (or do not want to create) a Jira service account with permissions required for automatic webhook management.

See Also

Jira Integration