remove-restrictions trigger action

1 Overview | 2 "remove-restrictions" | 2.1 Example trigger code | 3 Related Pages

Overview

You can use the remove-restrictions action in a workflow trigger to remove page-level permissions from your document, for example, when an approval occurs or when transitioning to a different state in your workflow. This can be used to ensure that page-level restrictions do not block your documentation process.

When the workflow trigger event occurs, the trigger checks that any required conditions are met, and if met, the "remove-restrictions" action removes page-level content view and edit restrictions from the current page, or a page specified using the contentId.

`"remove-restrictions"`

The trigger action "remove-restrictions" removes content view and edit restrictions for all users and groups.

action (remove-restrictions)
- contentId - the Confluence contentId of the page to remove page-level restrictions (optional)
  - if no contentId is added, the current page contentId is used

Example trigger code

A typical use of this trigger action is to remove all view and edit restrictions from the final state in a workflow.

"triggers":
[
	{"event": "on-change-state",
	"conditions":
	[
		{"final":true}
	],
	"actions":
	[
		{"action": "remove-restrictions"}
	]}
]

In the app space settings, an administrator can configure the space to remove all page-level restrictions on transitioning to the final state of the active workflow.

Only 'Confluence Cloud Standard, Premium, and Enterprise Plans enable Atlassian Confluence users to edit permissions, including global, space, and page permissions.