Permissions and Per-Work-Item Sync Control | mgm Marketplace App Documentation

📘 What you will learn here

On this page you will learn who can do what in Sync Bridge and how Jira administrators set up the per-work-item sync switch so people can turn a sync rule on or off for individual work items.

Sync Bridge uses your existing Jira permissions. It doesn't add its own roles.

Who can do what

Action	Who can do it
Open the Sync Bridge admin page: dashboard, connectors, sync rules, Sync history, API tokens and settings	Jira administrators
See the Sync Bridge panel on a work item and the sync status of each rule	Anyone with the Browse projects permission for the work item
See the Sync history tab on a work item	Anyone with the Browse projects permission for the work item
Start a sync from the panel (Push all, push, pull), Retry a failed sync, recheck an archived or deleted link, or Unlink a work item	Jira administrators
Retry a failed sync from the admin Sync history page	Jira administrators
Turn a sync rule on or off for a single work item	People you allow in the rule's Per-work-item sync switch settings (see below)
Start a sync through the API	Any service that has a valid API token for the rule. See API Tokens.

Being a Jira administrator doesn't by itself let you use the per-work-item switch. To include administrators, add the Jira administrators permission to the rule's Who can use the switch list.

Automatic syncs (from work item events and pull schedules) run as the Sync Bridge app, not as the person who changed the work item. On the other Jira site, Sync Bridge acts as the account saved in the connector.

Per-work-item sync control

By default, a sync rule syncs every work item that matches its scope. Turn on the Per-work-item sync switch when people need to decide, work item by work item, whether the rule applies. They then use a switch for that rule in the work item's Sync Bridge panel.

When sync is off for a work item, the rule doesn't push or pull that work item, whatever started the sync. A manual sync attempt shows Sync is turned off for this work item.

Set up the switch

Open the Sync Bridge admin page, select Sync rules and open the rule.
On the Configuration tab, turn on Per-work-item sync switch ("Let people turn this rule on or off for individual work items.").
Under Default for matching work items, choose a default (see the table below).
Under Who can use the switch, select Add people or permissions and choose a type. Then select the users, groups, roles or permissions. To add another type, select Add another.
Save the rule.

Default	What it does	Use it when
On by default	All matching work items sync. People you allow can turn sync off for a work item.	Most work items should sync and a few should be excluded.
Off by default	Work items don't sync until someone you allow turns sync on for them.	Only selected work items should sync.

When you first turn on the switch, the default is On by default, so nothing stops syncing until someone turns it off for a work item.

Choosing Off by default on a rule that is already running stops it for every matching work item that nobody has turned on yet.

Who can use the switch

Anyone who matches at least one row can use the switch. Each type can be added once.

Row	Who it allows
Permissions	Anyone with one of the selected Jira permissions on the work item: Jira administrators, Project administrators or Anyone who can edit the work item.
Users	Only the people you select.
Groups	Anyone in one of the selected groups.
Project roles	Anyone with one of the selected roles in the work item's space, including people who have the role through a group.

You must add at least one row, and each row needs at least one selection. Otherwise the rule can't be saved: "Add at least one user, group, project role or permission that can use the switch."

Good to know

Sync Bridge checks permissions again every time someone uses the switch, so changes to groups, roles or permissions in Jira apply straight away.
The switch is only available while the rule is turned on.
If you turn off Per-work-item sync switch, the rule syncs every matching work item again. Your list of who can use the switch is kept, and the choices people made on work items take effect again if you turn the switch back on.
You can find work items where someone has turned a rule on or off with JQL. See Search Synced Work Items with JQL.