Each macro that can be restricted must have at least one configuration entry in the Macro Security properties file. This is known as a Use Restrictions.
For example, the Cache macro might have an entry that looks like one of the following:
cache = *ANY cache = confluence-administrators cache = confluence-administrators, trusted-users-cache cache = bswift cache = space:DEMO
In the above example:
- "cache" is the property key and the information after the equal sign (=) is the property value.
- Both property keys and property values are case-sensitive.
- Property values are a comma separated list of groups or userids, or space keys in the form of
space:xxx
where "xxx" is the space key. - Line 1 uses
*ANY
to denote that anyone can create and edit content that uses the Cache macro, effectively making its use "unrestricted." - Line 2 indicates that only members of the "confluence-administrators" group can create and edit content that uses the Cache macro. (Content using the Cache macro would require an "edit" page restriction indicating only members of the "confluence-administrators" group can edit the page or, alternatively, an "edit page restriction to one or more userids who are members of the confluence-administrators group.)
- Line 3 indicates that only members of the "confluence-administrators" and "trusted-users-cache" groups can create and edit content that uses the Cache macro. (Content using the Cache macro would require an "edit" page restriction indicating that only members of the "confluence-administrators" group and/or "trusted-users-cache" group can edit the page or, alternatively, an "edit page restriction to one or more userids who are members of those groups.)
- Line 4 indicates that only the user "bswift" can create or edit content that uses the Cache macro. (Content using the Cache macro would require an "edit" page restriction indicating only user "bswift" can edit the page.)
- Line 5 indicates that only content within the space having a spaceKey of "DEMO" can use the Cache macro. (The space would require space-level permissions that indicate only trusted users and/or groups can add pages, blogs or comments. These trusted users and/or groups need not be listed in the properties file on the entry—like this one—that uses space-based Macro Security.)
You can also combine several of these into a single entry if you like, such as:
cache = confluence-administrators, trusted-users-cache, bswift