TWiki/ManagingUsers.mdwn

   1 <div>
   2   <ul>
   3     <li><a href="#Manage Users"> Manage Users</a><ul>
   4         <li><a href="#Authentication and Access Contro"> Authentication and Access Control</a></li>
   5         <li><a href="#Register User"> Register User</a></li>
   6         <li><a href="#Change, Reset and Install Passwo"> Change, Reset and Install Passwords</a></li>
   7         <li><a href="#Changing User Account Names"> Changing User Account Names</a></li>
   8         <li><a href="#Removing User Accounts"> Removing User Accounts</a></li>
   9       </ul>
  10     </li>
  11   </ul>
  12 </div>
  13
  14 # <a name="Manage Users"></a> Manage Users
  15
  16 _Register users on your TWiki site; change/reset/install passwords; remove user accounts_
  17
  18 ## <a name="Authentication and Access Contro"></a> Authentication and Access Control
  19
  20 - [[TWikiUserAuthentication]] describes options of user authentication
  21 - [[TWikiAccessControl]] describes how to define groups and how to restrict access to content
  22
  23 ## <a name="Register User"></a> Register User
  24
  25 It is not necessary to have user home pages in the TWiki system for Authentication to work - see [[TWikiUserAuthentication]] for details.
  26
  27 - [[TWikiRegistration]] is for users to fill out a form
  28 - [[NewUserTemplate]] can be changed to customize user home pages, it can optionally use the [[UserForm]] to define user fields as meta data
  29 - [[BulkRegistration]] is for administrators to use to set up one or more accounts: either from a table or from an external file
  30
  31 ## <a name="Change, Reset and Install Passwo"></a> Change, Reset and Install Passwords
  32
  33 - [[ChangePassword]] is for users who can remember their password and want to change it
  34 - [[ResetPassword]] is for users who cannot remember their password; a system generated password is e-mailed to them
  35 - [[BulkResetPassword]] if for administrators who want to reset many passwords at once
  36
  37 ## <a name="Changing User Account Names"></a> Changing User Account Names
  38
  39 To change the user's [[WikiName]]:
  40
  41 - Rename the user's TWiki homepage in the Main web, such as from `JaneSmith` to `JaneMiller`.
  42   - Fix backlinks in the Main web only
  43   - Make sure the group topics are updated (if any.)
  44 - Edit the [[Main.TWikiUsers|Main/TWikiUsers]] topic and move the user's entry so that the list is in proper alphabetical order.
  45 - 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`
  46
  47 If external authentication is used and you want to change the login name:
  48
  49 - The login name needs to be changed in the directory server, such as AD or LDAP
  50 - In TWiki's [[Main.TWikiUsers|Main/TWikiUsers]] topic, fix the mapping from login name to [[WikiName]] such as from:%BR% `   * JohnSmith - john - 13 Sep 2006` %BR% to: %BR% `   * JohnSmith - jsmith - 13 Sep 2006`
  51
  52 ## <a name="Removing User Accounts"></a> Removing User Accounts
  53
  54 To remove a user account (FredQuimby, who logs in as "fred"):
  55
  56 1. If you are using a `.htpasswd` file, edit the `.htpasswd` file to delete the line starting `fred:`
  57   - **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.
  58 2. Remove the `FredQuimby - fred` line from the Main.TWikiUsers topic
  59 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.
  60 4. _[optional]_ Delete their user topic Main.FredQuimby (including attachments, if any.)
  61
  62 **_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 with the organization or has been banished, 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..
  63
  64 **_Related Topics:_** [[AdminDocumentationCategory]]