add-restriction macro
- Robert Alexander Marshall
Overview
The add-restriction macro is used to add view or edit content-level permissions.
When using the add-restriction macro the specified Confluence permissions are restricted to the users listed.
Restrictions don't give users permission for a page or blog post - they limit the permissions to the named users.
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 user A and user B can edit the page. Everyone else is only able to view the page.
Where to use it?
Optional.
One or more add-restriction macros can be put in a trigger macro.
If you want to remove these restrictions you can use the remove-restriction macro.
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.†
Parameters
Parameter | Required | Default | Notes |
|---|---|---|---|
| What type of permission to set?
| ||
Note: The permissions are set using Confluence's content-level permissions system and can thus be altered via the padlock icon. | |||
| One or more users to assign
| ||
| One or more user groups to assign
| ||
At least one user or group must be specified. Both can also be used at the same time. | |||
† In some cases, due to Confluence permission threads, rather than using remove-restriction macro then | |||
From v6.16.14+, when adding the | |||
Example
The following examples restrict view permission to
the user who created the page
users who are members of the Confluence user group moderators
Adding a view restriction on creating a new page:
{workflow:Restrictions}
{state:Test}
{state}
{trigger:pagecreated}
{add-restriction:type=view|user=@user@|group=moderators}
{trigger}
{workflow}Adding a view restriction on creating a new blog post:
{workflow:Restrictions}
{state:Test}
{state}
{trigger:newscreated}
{add-restriction:type=view|user=@user@|group=moderators}
{trigger}
{workflow}Adding a view restriction on creating a new blog post or a new page requires both the above triggers in the applied workflow:
{workflow:Restrictions}
{state:Test}
{state}
{trigger:newscreated}
{add-restriction:type=view|user=@user@|group=moderators}
{trigger}
{trigger:pagecreated}
{add-restriction:type=view|user=@user@|group=moderators}
{trigger}
{workflow}The restrictions can then be removed, for example, on approving the content
All examples
See also
External Links: