Skip to content

Commit

Permalink
Item13883: Improve docs for remove users
Browse files Browse the repository at this point in the history
 - RemoveUser should be a sepatate "tool" topic and not embedded in a
   documentation topic.
 - It's missed from AdminToolsCategory
  • Loading branch information
gac410 committed Dec 28, 2016
1 parent edb101c commit d64ed8d
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 36 deletions.
36 changes: 2 additions & 34 deletions TopicUserMappingContrib/data/System/ManagingUsers.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1479234842" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1482950646" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
%STARTINCLUDE%
---+ Manage Users
Expand Down Expand Up @@ -63,39 +63,7 @@ If external authentication is used and you want to change the login username:

---++ Removing User Accounts

The following API can be used by administrators to delete a user's account.
* The user is removed from the user database.
* The user's topic is moved to the trash web
* The user is removed from any groups

<!-- %JQREQUIRE{"ui, ui::autocomplete"}% -->
<form name="admin" action="%SCRIPTURLPATH{manage}%/%WEB%/%TOPIC%" method="post">
<div class="foswikiFormSteps">
<div class="foswikiFormStep">
---++++!! Enter user to be removed
%INCLUDE{"%SYSTEMWEB%.JQueryAjaxHelper" section="userselector" INPUT_NAME="user" MULTI="false"}%
<hr />
---++++!! Remove user topic?
<input type="checkbox" id="removeTopic" name="removeTopic" checked="checked" class="foswikiCheckbox" /> _(Check to remove topic)_
Prefix for deleted topic: <input type="text" name="topicPrefix" class="foswikiInputField" value="DeletedUser" /> _(Follow topic naming rules)_
<hr />
<input type="hidden" name="action" value="deleteUserAccount" />
<input type="submit" class="foswikiSubmit" value="Remove User" />
</form>
</div>
</div>


*Note:* Consider leaving the user topic file in place so their past signatures and revision author entries don't end up looking like AnUncreatedTopic.
If you want to make it clear the user is no longer around, replace the topic content with a note to that effect.
The existence of the <nop>UserName topic should also prevent that username from being re-used, sealing the potential security hole regarding inherited permissions.

<div class="foswikiHelp">
%T% See the [[http://foswiki.org/Extensions/AntiWikiSpamPlugin][AntiWikiSpamPlugin]] extension for another method of removing users. It provides a =rest= handler to:
* Move the user topic to the Trash web.
* Remove the user from the password / mapper
* Remove the user from any groups.
</div>
%INCLUDE{"RemoveUser"}%

---++ Configuring User Registration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ data/System/FAQRebuildingWikiUsersTopic.txt 0644
data/System/ManagingUsers.txt 0644
data/System/NewUserTemplate.txt 0644
data/System/ResetPassword.txt 0644
data/System/RemoveUser.txt 0644
data/System/TopicUserMappingContrib.txt 0644
data/System/UserForm.txt 0644
data/System/UserFormHelp.txt 0644
Expand Down
4 changes: 2 additions & 2 deletions core/data/System/AdminToolsCategory.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1435796369" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1482950646" format="1.1" version="1"}%
%META:TOPICPARENT{name="Category"}%
---+ Admin tools

Expand All @@ -7,7 +7,7 @@ List of tools available to the Foswiki administrator
* %ICON{help}% Documentation: [[ReferenceManual][Reference Manual]]
* %ICON{wrench}% [[Site Tools]]: %WIKIPREFSTOPIC%, InterWikis, [[%SYSTEMWEB%.Macros][Macros]], [[DocumentGraphics][Doc Graphics]]
* %ICON{gear}% Server operation: [[%SCRIPTURLPATH{"configure"}%][Configure]], [[InstalledPlugins][Extensions & Diagnostics]], [[PerlDependencyReport][Perl Dependencies]]. [[FoswikiServerInformation][Server execution details]]
* %ICON{persons}% Manage [[%USERSWEB%.%WIKIUSERSTOPIC%][Users]]: [[UserRegistration][Register]], [[%USERSWEB%.WikiGroups][Groups]], %SYSTEMWEB%.NewUserTemplate, %SYSTEMWEB%.UserForm, ResetPassword, ChangePassword, ChangeEmailAddress
* %ICON{persons}% Manage [[%USERSWEB%.%WIKIUSERSTOPIC%][Users]]: [[UserRegistration][Register]], [[RemoveUser][Remove]], [[%USERSWEB%.WikiGroups][Groups]], %SYSTEMWEB%.NewUserTemplate, %SYSTEMWEB%.UserForm, ResetPassword, ChangePassword, ChangeEmailAddress, PendingRegistrations
* %ICON{indexlist}% Manage Content: [[ManagingTopics][Topics]], [[ManagingWebs][Webs]]

---++ All Admin Tools Category topics
Expand Down

0 comments on commit d64ed8d

Please sign in to comment.