TWiki/ManagingUsers.mdwn

   1 # <a name="Manage Users"></a> Manage Users
   2
   3 _Register users on your TWiki site; change/reset/install passwords; remove user accounts_
   4
   5 <div>
   6   <ul>
   7     <li><a href="#Manage Users"> Manage Users</a><ul>
   8         <li><a href="#Authentication and Access Contro"> Authentication and Access Control</a></li>
   9         <li><a href="#Register User"> Register User</a></li>
  10         <li><a href="#Change, Reset and Install Passwo"> Change, Reset and Install Passwords</a></li>
  11         <li><a href="#Changing User Account Names"> Changing User Account Names</a></li>
  12         <li><a href="#Removing User Accounts"> Removing User Accounts</a></li>
  13       </ul>
  14     </li>
  15   </ul>
  16 </div>
  17
  18 %X% Some of the features below may be disabled, depending on your TWiki configuration.
  19
  20 ## <a name="Authentication and Access Contro"></a> Authentication and Access Control
  21
  22 - [[TWikiUserAuthentication]] describes your options for user authentication
  23 - [[TWikiAccessControl]] describes how to define groups and how to restrict access to content
  24
  25 ## <a name="Register User"></a> Register User
  26
  27 You don't have to have user home pages in TWiki for Authentication to work - see [[TWikiUserAuthentication]] for details.
  28
  29 - [[TWikiRegistration]] is used when you want new users to individually register with TWiki by filling out a form
  30 - You can create a custom versions of [[NewUserTemplate]] and [[UserForm]]
  31 - [[BulkRegistration]] is used by administrators to register multiple users at the same time
  32
  33 ## <a name="Change, Reset and Install Passwo"></a> Change, Reset and Install Passwords
  34
  35 _Note that the below features are only relevant when you use an internal password manager where TWiki can set and reset passwords._
  36
  37 - [[ChangePassword]] is for users who _can_ remember their password and want to change it
  38 - [[ResetPassword]] is for users who _cannot_ remember their password; a system generated password is e-mailed to them
  39 - [[BulkResetPassword]] if for administrators who want to reset many passwords at once
  40 - [[ChangeEmailAddress]] changes the hidden email address stored in the password file
  41
  42 ## <a name="Changing User Account Names"></a> Changing User Account Names
  43
  44 To change the user's [[WikiName]]:
  45
  46 - Rename the user's TWiki homepage in the Main web, such as from `JaneSmith` to `JaneMiller`.
  47   - Fix backlinks in the Main web only
  48   - Make sure the group topics are updated (if any.)
  49 - Edit the [[Main.TWikiUsers|Main/TWikiUsers]] topic and move the user's entry so that the list is in proper alphabetical order.
  50 - Recreate the old topic with a pointer to the new topic, so that links in other webs work properly. Example content:%BR% `%M% Jane Smith is now known as JaneMiller`
  51
  52 If external authentication is used and you want to change the login name:
  53
  54 - The login name needs to be changed in the authentication server (e.g. Active Directory)
  55 - In TWiki's [[Main.TWikiUsers|Main/TWikiUsers]] topic, fix the mapping from login name to [[WikiName]]:%BR% `   * JaneSmith - jsmith - 13 Sep 2006` %BR% to: %BR% `   * JaneMiller - jmiller - 13 Sep 2006`
  56
  57 ## <a name="Removing User Accounts"></a> Removing User Accounts
  58
  59 To remove a user account (FredQuimby, who logs in as "fred"):
  60
  61 1. If you are using a `.htpasswd` file, edit the `.htpasswd` file to delete the line starting `fred:`
  62   - **Warning:** Do **not** use the Apache `htpasswd` program with `.htpasswd` files generated by TWiki! `htpasswd` wipes out email addresses that TWiki plants in the info fields of this file.
  63 2. Remove the `FredQuimby - fred` line from the Main.TWikiUsers topic
  64 3. Remove `FredQuimby` from all groups and from all the `ALLOWWEB/ALLOWTOPIC...` declarations, if any.%BR% **_Note:_** If you fail to do this you risk creating a security hole, as the next user to register with the wikiname FredQuimby will inherit the old FredQuimby's permissions.
  65 4. _[optional]_ Delete their user topic Main.FredQuimby (including attachments, if any.)
  66
  67 **_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 existance of the UserName topic should also prevent that user name from being re-used, sealing the potential security hole regarding inherited permissions..
  68
  69 **_Related Topics:_** [[AdminDocumentationCategory]]