Skip to Content

Wiki source code of User Management

Version 91.1 by Manuel Leduc on 2024/04/22
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 {{info}}
6 * These instructions assume you're using XWiki 1.2 or later with the **[[Albatross, Toucan or Colibri skins>>Documentation.AdminGuide.Skins]]** (screenshots for Colibri).
7 * The default skin is currently Colibri.
8 {{/info}}
9
10 = Adding users to your wiki =
11
12 1. Log in as an administrator
13 1. Hover over "Wiki" and click on "Administer Wiki"
14 1. Click on the "Users" link to bring up an overview of all the users
15 1. Click on the "Add new user" button to open a registration page as shown on the image below
16 1. Fill in the user information
17 1. Click "Save":(((
18 {{image reference="AddUser.png"/}}
19 )))
20
21 = Changing a user's password =
22
23 == Changing the password for any user ==
24
25 1. Log in as an administrator
26 1. Hover over "Wiki" and click on "Administer Wiki"
27 1. Click on the "Users" link to bring up an overview of all the users
28 1. Click on the name of the user for which you want to change the password (this will take you to the user's profile page)
29 1. Click on the "Preferences" tab
30 1. Click on the "Change Password" button
31 1. Enter the new password twice
32 1. Click on the "Update" button(((
33 {{image reference="ChangePassword.png"/}}
34
35 {{warning}}
36 Don't forget to notify the user!
37 {{/warning}}
38 )))
39
40 == Changing the password for the logged in user ==
41
42 To change **your own password** follow these steps:
43
44 1. Click on your user name in the top right corner of the screen (this will redirect you to your profile)
45 1. Click on the "Preferences" tab
46 1. Click on the "Change password" button
47 1. Enter your current password (only needed since XWiki 5.1) and the new password twice
48 1. Click on the "Save" button(((
49 {{image reference="ChangeOwnPassword.png"/}}
50 )))
51
52 == Changing the password security policy ==
53
54 {{info}}XWiki 11.9{{/info}} You can define the password security for all the users of the wiki. The policy is defined by some rules available in the Administration > Users & Rights > Registration page. You can specify the minimum length of the password, and if it must contain numbers, lower/upper case characters, and symbol.
55
56 {{image reference="password-policy-fields.png"/}}
57
58 Please note that when the rules are changed, all further password changes must comply with the new rules, but the older password are still all valid.
59
60 = Editing an existing user =
61
62 1. Log in as an administrator
63 1. Hover over "Wiki" and click on "Administer Wiki"
64 1. Click on the "Users" link to bring up an overview of all the users
65 1. You have two options:
66 11. Click the user name for the user you want to edit
67 11*. On the user's profile page click on the small yellow pencil corresponding to the information you want to edit (profile or preferences)
68 11*. Click "Save and View" to save the changes you have made
69 11. Click on the small yellow pencil near the user you want to edit (this will open up a lightbox with the main information of that user)
70 11*. Make your modifications and click "Save"(((
71 {{info}}
72 There is also a link to the complete user profile, where you can proceed as above (first option).
73 {{/info}}
74
75 {{image reference="EditUserProfile.png" width="580px"/}}
76 )))
77
78 = Disabling a user =
79
80 == From the administration ==
81
82 [[image:user_administration_disable_account.png||height="271" width="960"]]
83
84 1. Log in as an administrator
85 1. Go to the User section of the Wiki administration
86 1. Click on the closed lock to disable a user
87
88 To enable a user, follow the same steps but click on the opened lock.
89
90 == From a user profile ==
91
92 [[image:user_profile_enabled_account.png||height="415" width="960"]]
93
94 1. Login an an administrator
95 1. Visit a user profile
96 1. Click on the "Disable this account" action.
97
98 [[image:user_profile_disabled_account.png||height="387" width="960"]]
99
100 To enable a user, follow the same step but click on the "Enable this account" action.
101
102 = Deleting a user =
103
104 1. Log in as an administrator
105 1. Go to the User section of the Wiki administration
106 1. Delete the user by clicking the red "X" corresponding to the user you want to delete (the user will be automatically removed from all the groups it belonged to)(((
107 {{info}}
108 You won't be able to delete the currently logged in user and you'll need to log-in using other credentials. This is done in order to prevent mistakes.
109 {{/info}}
110
111 [[image:user_administration_disable_account.png||height="271" width="960"]]
112 )))
113
114 = Modify the number of users displayed in the list =
115
116 This is valid as of v3.5 (I think it works on any 3.x version).
117
118 You have to edit ##XWiki.AdminUsersSheet## for users. The page contains a line like this:
119
120 {{code}}
121 var ta = new XWiki.widgets.LiveTable("$url", "userstable", callback);
122 {{/code}}
123
124 Replace it with:
125
126 {{code}}
127 var ta = new XWiki.widgets.LiveTable("$url", "userstable", callback, {limit: 100});
128 {{/code}}
129
130 where 100 is the number of items displayed per page.
131
132 = Customizing the Registration page =
133
134 {{info}}
135 Since [[XWiki Exterprise 2.2M2>>xwiki:ReleaseNotes.ReleaseNotesXWikiEnterprise22M2#HNewRegistrationpage]] customizing the registration page is done by the "Verified Registration" Page, part of the [[Administration Application>>extensions:Extension.Administration Application]]. This provides more features such as captcha and client side validation of user input. For more information about how to configure it, visit the [[application page>>extensions:Extension.Administration Application]].
136 {{/info}}
137
138 In order to customize the registration page you must follow these steps:
139
140 1. Log in as an administrator
141 1. Click on the right drawer icon, then click on "Administer Wiki"
142 1. Go to "Users & Rights" > "Registration"
143 1. Make your modifications and click "Save":(((
144 {{image reference="Registration.png" width="960px"/}}
145 )))
146
147 {{error}}
148 Be sure to fill in admin's e-mail in Administration -> Configuration -> Email. Otherwise XWiki prior 4.5 won't send verification e-mails while E-mail verification is on.
149 {{/error}}
150
151 = Enable/Disable User Account =
152
153 Starting with {{code}}XWiki 11.6RC1{{/code}} it is now possible to disable a user account and to enable it back from his/her profile.
154 A disabled user is able to login but cannot perform any action once logged-in.
155
156 {{gallery}}
157 image:disable-account.png
158 image:enable-account.png
159 image:account-disabled-warning.png
160 {{/gallery}}
161
162 = Inactive Users =
163
164 If you configured the registration page to enable the **Use Email Verification**, then new registered users are by default inactive. The user account is activated by a link on the email. (See more information in [[Administration Application>>extensions:Extension.Administration Application]]).
165
166 Starting with {{code}}XWiki 11.6RC1{{/code}} the inactive users are prevented to get access to most pages of the wiki by default. The page they can get access to can be configured in the [[configuration>>Documentation.AdminGuide.Configuration#HAllowedPagesforInactiveUsers]].
167
168 Prior from that, the **Authentication Active Check** must be checked in order for inactive users to get access to the wiki.

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected