Table of Contents | ||||||||
---|---|---|---|---|---|---|---|---|
|
Overview
Excerpt | ||
---|---|---|
| ||
Add content view/edit permissions |
The add-restriction
macro is used to add view or edit content-level permissions.
When using the the add-restriction
macro the macro the specified Confluence permission will be added permissions are restricted to the users listed.If there are other users who have Confluence permissions for the content but are not listed in the macro, these users will have their permissions restricted
Info |
---|
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
macrotrigger 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†.
...
Restrictions don't give users permissions to content, but rather limit the users who have those permissions.
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
| |||
|
| ||||
† In some cases, due to Confluence permission threads, rather than using remove-restriction macro then |
. This macro clears any existing restriction of the type being set (view or edit) before setting that permission for the listed users or groups. |
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:
Code Block | ||
---|---|---|
| ||
{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:
Code Block | ||||
---|---|---|---|---|
| ||||
{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:
Code Block | ||
---|---|---|
| ||
{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
Code Block | ||
---|---|---|
| ||
{workflow:Restrictions} {state:Draft|approved=Published} {approval=Publish|group=moderators|minimimum=2} {state} {state:Published|final=true|updated=Draft} {state} {trigger:newscreated} {add-restriction:type=view|user=@user@|group=moderators} {trigger} {trigger:pagecreated} {add-restriction:type=view|user=@user@|group=moderators} {trigger} {trigger:pageapproved} {remove-restriction:type=view} {trigger} {trigger:newsapproved} {remove-restriction:type=view} {trigger} {workflow} |
These examples use the newscreated
and pagecreated
events to limit the page-level permissions. They only work when the workflow is a space workflow and the workflow is enabled in the space at the time the page or blog post is created.
All examples
Filter by label (Content by label) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
See also
External Links: