remove-restriction macro

1 Where to use it? | 2 Parameters | 3 Example | 4 All examples | 5 See also

Overview

The remove-restriction macro is used to remove View or Edit content-level permissions.

Where to use it?

Optional.

One or more remove-restriction macros can be put in a trigger macro.

This macro removes restriction limits that has been set for the permission on the page.

The app add-restriction and set-restrictions macros do not give users permissions to content, but rather limit the users who have those permissions.

For example, if everyone has edit/view permissions for the space and you add edit restrictions to a page - for user A and user B - only the named users can edit the page. Everyone else can only view the page.

You can remove/add or add/remove restrictions using these macros in any order.

If you want to add restrictions immediately after removing restrictions of the same type, you can use the set-restrictions macro instead.†

If you want to add restrictions you can use the add-restriction macro.

Parameters

Parameter	Required	Default	Notes
`type`			What type of permission to remove? `view` – assign the user/group view permission `edit` – assign the user/group edit permission
`type`			Note: The permissions are set using Confluence's content-level permissions system and can thus be altered via the padlock icon.
`user`			One or more users to remove `type` permission from: Comma-separated list of usernames Supports Value References
`group`			One or more user groups to remove `type` permission from: Comma-separated list of user groups Supports Value References
If neither `user` or `group` parameters are defined, then all content-level permissions of `type` will be removed.
† In some cases, due to Confluence permission threads, rather than using `remove-restriction` macro then the add-restriction macro, it may be useful to use set-restrictions macro. The set-restrictions macro clears any existing restriction of the type being set (view or edit) before setting that permission for the listed users or groups.

Example

{workflow:Restrictions}
   {state:Review|approved=Published}
      {approval:Review}
   {state}
   {state:Published}
   {state}
   {trigger:pageapproved|approval=Review}
      {remove-restriction:type=view}
      {remove-restriction:type=edit}
   {trigger}
{workflow}

If the workflow is applied to a blog post, a trigger must use the appropriate event for a blog post. For example, the newsapproved event

{workflow:Restrictions}
   {state:Review|approved=Published}
      {approval:Review}
   {state}
   {state:Published}
   {state}
   {trigger:pageapproved|approval=Review}
      {remove-restriction:type=view}
      {remove-restriction:type=edit}
   {trigger}
   {trigger:newsapproved|approval=Review}
      {remove-restriction:type=view}
      {remove-restriction:type=edit}
   {trigger}
{workflow}