remove-restrictions trigger action
- Robert Alexander Marshall
Overview
The remove restrictions action in a workflow trigger can be used to remove page-level permissions from your document, for example, when an approval occurs or a move to a new state in your workflow where document actions can be for different users to the previous state.
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 for specified users and user groups.
One or more trigger actions can be set for a named event in the workflow.
"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
if no contentId is included, 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"}
]}
]When adding the JSON trigger using the workflow builder visual editor, there is no need to include the opening "triggers": JSON markup notation; it is added automatically by the workflow builder.
In the app space settings, a space 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.