Atlassian Connect Symfony Bundle

2.4.0 2018-02-17 11:59 UTC


Build Status Code Coverage Scrutinizer Code Quality License Latest Stable Version Total Downloads


Symfony Bundle for Atlassian Connect platform


Step 1. Add bundle to composer dependencies

Without Symfony Flex:

composer require thecatontheflat/atlassian-connect-bundle

Step 2. Add bundle to kernel

Add the bundle to app/AppKernel.php

$bundles = array(
	// ... other bundles
	new AtlassianConnectBundle\AtlassianConnectBundle(),

Step 3. Bundle configuration

Bundle configuration includes has two main nodes - prod and dev. When requesting descriptor - this configuration is converted to JSON. Whatever you specify under dev node will override same option from prod. Sample configuration in config.yml:

        dev_tenant: 1
            key: 'your-addon-key'
            name: 'Your Add-On Name'
            description: 'Your Add-On Description'
                name: 'Your Vendor Name'
                url: ''
            baseUrl: ''
                installed: '/handshake'
            scopes: ['READ', 'WRITE']
                        key: 'your-addon-key-tab'
                        url: '/protected/list?issue=${issue.key}'
                        weight: 100
                            value: 'Tab Name'

          baseUrl: 'http://localhost:8888'

Step 4. Security configuration

To configure security part - use the following configuration in your security.yml

                id: jwt_user_provider
                pattern: "^/protected"
                stateless: true
                    authenticator: jwt_authenticator

Step 5. Include Routes

  • For Symfony 4 and Flex to config/routes.yaml
  • For Symfony 2/3 to app/config/routing.yml

Add the following:

        resource: "@AtlassianConnectBundle/Resources/config/routing.yml"

Step 6. (Optional): Configure License Check

To perform a license check for a certain route - specify the requires_license options in your routing.yml

        path: ...
        defaults: ...
            requires_license: true

Step 7. Update Database

bin/console doctrine:schema:update --force

Usage Examples

Signed Request

In your protected controller action you can make a signed request to JIRA instance:

<?php declare(strict_types = 1);

namespace App\Controller;

use AtlassianConnectBundle\Service\AtlassianRestClient;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Response;

 * @Route("/protected")
class ProtectedController extends Controller
     * @Route("/", name="main")
    public function index()
        $client = $this->container->get(AtlassianRestClient::class);
        // Send request from anonymous plugin user
        $issue = $client->get('/rest/api/2/issue/KEY-XXX');
        // Send request from choosen user
        $user = $client
            ->setUser('admin') // the primary key of the user in Jira/Confluence etc.
        return new Response([$issue, $user]);

White listening licences

You could white-list any licence by editing related row in table tenant and setting field is_white_listed to 1. If you will also set white_listed_until - you will be able to set white-list expiration

Dev environment

In dev environment Tenant with id=1 would be used automatically. You could set configuration variable atlassian_connect.dev_tenant to false in order to disable it, or use another dev tenant id. It would allow you to test your plugin output for any tenant.

Custom tenant entity

If you need to add more properties to tenant entity or reverse-side of your app entity relations - you could override default Tenant entity like

    namespace AppBundle\Entity;
    use Doctrine\ORM\Mapping as ORM;
    use AtlassianConnectBundle\Entity\TenantTrait;
    use AtlassianConnectBundle\Entity\TenantInterface;
    use Symfony\Component\Security\Core\User\UserInterface;
     * JiraTenant
     * @ORM\Table()
     * @ORM\HasLifecycleCallbacks()
     * @ORM\Entity()
    class JiraTenant implements UserInterface, TenantInterface
         * @ORM\OneToMany(type="MyEntity", mappedBy="jiraTenant")
        protected $myEntities;
        use TenantTrait;    
        // getters/setters for your custom properties

And override default one by setting parameter

    atlassian_connect_tenant_entity_class: AppBundle\Entity\JiraTenant

In order to use it you will need to disable doctrine automapping

    auto_mapping: false
            AppBundle: ~


Cant start free trial of my plugin on Jira Cloud

As soon as you will create your plugin - you will be able to access plugin manifest via url

You will be able to setup it in "Manage Addons" section of your Jira Cloud using "Upload addon" interface. But right now AtlassianConnectBundle support only "paid via Atlassian" model, so you will not be able to start your trial.

Instead of using manifest url directly - you should add private listing of your plugin, create token and get manifest url like

If you will use that url from marketplace - your trial will be started automatically.