Rights Management (XWiki.org)

The images and documentation below feature the new Rights Management UI available since XWiki Enterprise 1.1.2 and XWiki Enterprise 1.2M2 and beyond.

7

8

9

XWiki allows you to control all access permissions at a fine grained level. There are different levels of control and these rights are cumulative. The rights for a page override the rights for a space, which override the rights for a wiki.

10

11

Thanks to the three levels of control offered by XWiki, it becomes quite easy to manage places where people are allowed to read, write and comment - or not allowed to.

12

13

14

You can create groups of users in order to manage the rights of a category of people more easily.

15

16

17

For instance, say you have managers and staff in the marketing and IT department: you can create a group for the staff on each department and another for managers (4 in all), and a space for every category. Then you can choose to let marketing staff access the marketing space only, but let marketing managers have access to the IT space at the staff level (but not IT manager level), and so on...

18

19

20

You'll need to have the admin right granted in order to modify permissions for other users and groups.

21

22

23

= Rights at the wiki level =

24

25

Click on the "Wiki" menu and then on "Administer Wiki". Click on the "Rights" link located under "Users & Groups" as shown in the following images//~://

Since XWiki 7.2M3, the "Administer Link" is located in the Drawer, that you can enable by clicking on the top right icon.

Here's how you can change permissions:

40

41

* Select the Users or Groups for which you want to set a permission.

42

* Click once in a checkbox to allow a right, twice to deny it and three times to clear the right (delete the entry). As a result, rights entries are saved automatically, using the Ajax technology.

43

44

There are some default users and groups you need to know about:

45

46

* Unregistered Users: represents the anonymous user (i.e., a user not logged in)

47

* XWikiAllGroup: represents all groups

48

* XWikiAdminGroup: represents all users with admin privileges

49

50

= Rights at the space level =

51

52

In order to edit rights at the space level you need to click on the "Space" menu (located on the top bar), click "Administer Space" and then click on the "Rights" link.

Then use exactly the same steps as the ones used for changing global rights.

57

58

59

Since 7.2 RC 1, the notion of space does not exist anymore. But you can change the rights of the parent page, and it will affect the current page. See the next section to know more about this.

60

61

Note: on terminal pages (documents that cannot have child), there is an "Administer Parent" button in the "more actions" menu: (((

)))

= Rights at the page level =

67

68

69

This is available only to [[//Advanced users//>>Features.PageEditing#HAdvancedMode]], make sure you switch your account to Advanced mode before trying to edit page rights.

70

71

72

Simply navigate to the page for which you wish to change the permissions. Click on the arrow in the "Edit" menu and then on "Access Rights":

Since 7.2 RC 1, there is 2 ways to get to this page:

78

* if you are on a terminal page (a page that cannot have child), it's still on the same place (edit > access rights).

79

* if not, you have to go to the actions menu (the menu with 3 vertical dots) and then click on "Administer Page": (((

80

81

In this page, you will have 2 choices:

82

** "Rights: Page & Children" for the rights of this page that also affect the children of the page: (((

83

84

)))

85

** "Rights: Page" for the rights of this page only (children are not affected): (((

)))

)))

= Activating CAPTCHAs for anonymous comments =

92

93

94

Supported since XWiki Enterprise 2.3.

95

96

97

Go to the "Rights" administration page and tick the //Require unregistered users to solve a captcha when posting a comment on a page// check box as show on the following image//~://

Note that you also need to give the Comment right to unregistered users. After you've done so unregistered users will see the following when entering a comment on a page:

102

103

Wiki source code of Rights Management

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected

author	version	line-number	content
		1	{{box cssClass="floatinginfobox" title="Contents"}}
		2	{{toc/}}
		3	{{/box}}
		4
		5	{{info}}
		6	The images and documentation below feature the new Rights Management UI available since XWiki Enterprise 1.1.2 and XWiki Enterprise 1.2M2 and beyond.
		7	{{/info}}
		8
		9	XWiki allows you to control all access permissions at a fine grained level. There are different levels of control and these rights are cumulative. The rights for a page override the rights for a space, which override the rights for a wiki.
		10
		11	Thanks to the three levels of control offered by XWiki, it becomes quite easy to manage places where people are allowed to read, write and comment - or not allowed to.
		12
		13	{{info}}
		14	You can create groups of users in order to manage the rights of a category of people more easily.
		15	{{/info}}
		16
		17	For instance, say you have managers and staff in the marketing and IT department: you can create a group for the staff on each department and another for managers (4 in all), and a space for every category. Then you can choose to let marketing staff access the marketing space only, but let marketing managers have access to the IT space at the staff level (but not IT manager level), and so on...
		18
		19	{{warning}}
		20	You'll need to have the admin right granted in order to modify permissions for other users and groups.
		21	{{/warning}}
		22
		23	= Rights at the wiki level =
		24
		25	Click on the "Wiki" menu and then on "Administer Wiki". Click on the "Rights" link located under "Users & Groups" as shown in the following images//~://
		26
		27	{{image reference="AdministerWikiMenu.png"/}}
		28
		29	{{info}}
		30	Since XWiki 7.2M3, the "Administer Link" is located in the Drawer, that you can enable by clicking on the top right icon.
		31
		32	{{image reference="AdministerWikiMenuDrawer.png"/}}
		33	{{/info}}
		34
		35	{{image reference="AdministrationRights.png"/}}
		36
		37	{{image reference="globalrights.PNG"/}}
		38
		39	Here's how you can change permissions:
		40
		41	* Select the Users or Groups for which you want to set a permission.
		42	* Click once in a checkbox to allow a right, twice to deny it and three times to clear the right (delete the entry). As a result, rights entries are saved automatically, using the Ajax technology.
		43
		44	There are some default users and groups you need to know about:
		45
		46	* Unregistered Users: represents the anonymous user (i.e., a user not logged in)
		47	* XWikiAllGroup: represents all groups
		48	* XWikiAdminGroup: represents all users with admin privileges
		49
		50	= Rights at the space level =
		51
		52	In order to edit rights at the space level you need to click on the "Space" menu (located on the top bar), click "Administer Space" and then click on the "Rights" link.
		53
		54	{{image reference="spacerights.PNG"/}}
		55
		56	Then use exactly the same steps as the ones used for changing global rights.
		57
		58	{{info}}
		59	Since 7.2 RC 1, the notion of space does not exist anymore. But you can change the rights of the parent page, and it will affect the current page. See the next section to know more about this.
		60
		61	Note: on terminal pages (documents that cannot have child), there is an "Administer Parent" button in the "more actions" menu: (((
		62	{{image reference="AdministerParentMenu.png" /}}
		63	)))
		64	{{/info}}
		65
		66	= Rights at the page level =
		67
		68	{{warning}}
		69	This is available only to [[//Advanced users//>>Features.PageEditing#HAdvancedMode]], make sure you switch your account to Advanced mode before trying to edit page rights.
		70	{{/warning}}
		71
		72	Simply navigate to the page for which you wish to change the permissions. Click on the arrow in the "Edit" menu and then on "Access Rights":
		73
		74	{{image reference="pagerights.PNG"/}}
		75
		76	{{info}}
		77	Since 7.2 RC 1, there is 2 ways to get to this page:
		78	* if you are on a terminal page (a page that cannot have child), it's still on the same place (edit > access rights).
		79	* if not, you have to go to the actions menu (the menu with 3 vertical dots) and then click on "Administer Page": (((
		80	{{image reference="AdministerPageMenu.png" /}}
		81	In this page, you will have 2 choices:
		82	** "Rights: Page & Children" for the rights of this page that also affect the children of the page: (((
		83	{{image reference="AdministerPage.png" /}}
		84	)))
		85	** "Rights: Page" for the rights of this page only (children are not affected): (((
		86	{{image reference="AdministerPageRights.png" /}}
		87	)))
		88	)))
		89	{{/info}}
		90
		91	= Activating CAPTCHAs for anonymous comments =
		92
		93	{{info}}
		94	Supported since XWiki Enterprise 2.3.
		95	{{/info}}
		96
		97	Go to the "Rights" administration page and tick the //Require unregistered users to solve a captcha when posting a comment on a page// check box as show on the following image//~://
		98
		99	{{image reference="captchacomments.png"/}}
		100
		101	Note that you also need to give the Comment right to unregistered users. After you've done so unregistered users will see the following when entering a comment on a page:
		102
		103	{{image reference="anonymouscomment.png"/}}