Documentation/English (British)/developer-chapter3-edituser.htm

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
   2 <html>\r
   3         <head>\r
   4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
   5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
   6                 <title>Xestia Scanner Server Documentation - Developer Documentation - 3.13 edituser</title>\r
   7         </head>\r
   8         <body>\r
   9                 <div class="menubarback">\r
  10                         <div class="menubar">\r
  11                                 <span class="apptitle">Xestia Scanner Server</span>\r
  12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
  13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
  14 <a href="developer.html">Developer Documentation</a>\r
  15                         </div>\r
  16                 </div>\r
  17                 <div class="pageinformation">\r
  18                         <span class="pagetitle">3.13 edituser</span>\r
  19 <br><br>\r
  20 Edits a user’s details.\r
  21 <br><br>\r
  22 <b>Parameters:</b>\r
  23 <br><br>\r
  24 <div class="code">\r
  25 $xestiascan_authmodule->edituser(username, type, data);\r
  26 </div>\r
  27 <br><br>\r
  28 <b>Usage:</b>\r
  29 <br><br>\r
  30 <div class="code">\r
  31 $xestiascan_authmodule->edituser(“User”, “User”, %userdata);\r
  32 </div>\r
  33 <br><br>\r
  34 <i>username</i><br>\r
  35 Specifies the username to use.\r
  36 <br><br>\r
  37 <i>type</i><br>\r
  38 Specifies the type of data. This is either User, Scanner, OutputModule or ExportModule.\r
  39 <br><br>\r
  40 <i>data</i><br>\r
  41 Specifies the data as a hash.\r
  42 <br><br>\r
  43 User Data Type Hash:\r
  44 <br><br>\r
  45 <table class="infotable">\r
  46  <tr>\r
  47   <td class="tableheading">Setting</td>\r
  48   <td class="tableheading">Description</td>\r
  49  </tr>\r
  50  <tr>\r
  51   <td class="tabledata">Username</td>\r
  52   <td class="tabledata">Specifies the username to use for the new user.</td>\r
  53  </tr>\r
  54  <tr>\r
  55   <td class="tabledata">Name</td>\r
  56   <td class="tabledata">Specifies the name of the new user.</td>\r
  57  </tr>\r
  58  <tr>\r
  59   <td class="tabledata">Password</td>\r
  60   <td class="tabledata">Specifies the password to use.</td>\r
  61  </tr>\r
  62  <tr>\r
  63   <td class="tabledata">ConfirmPassword</td>\r
  64   <td class="tabledata">Specifies the confirmed password to use (should be same as Password).</td>\r
  65  </tr>\r
  66  <tr>\r
  67   <td class="tabledata">Admin</td>\r
  68   <td class="tabledata">Specifies if the account has administrative privileges.</td>\r
  69  </tr>\r
  70  <tr>\r
  71   <td class="tabledata">Enabled</td>\r
  72   <td class="tabledata">Specifies if the account is enabled or not.</td>\r
  73  </tr>\r
  74 </table>\r
  75 <br><br>\r
  76 Scanner Data Type Hash:\r
  77 <br><br>\r
  78 <table class="infotable">\r
  79  <tr>\r
  80   <td class="tableheading">Setting</td>\r
  81   <td class="tableheading">Description</td>\r
  82  </tr>\r
  83  <tr>\r
  84   <td class="tabledata">ScannerID</td>\r
  85   <td class="tabledata">Specifies the scanner ID. A setting of “on” means the user should have permission to use this scanner.</td>\r
  86  </tr>\r
  87 </table>\r
  88 <br><br>\r
  89 OutputModule Data Type Hash:\r
  90 <br><br>\r
  91 <table class="infotable">\r
  92  <tr>\r
  93   <td class="tableheading">Setting</td>\r
  94   <td class="tableheading">Description</td>\r
  95  </tr>\r
  96  <tr>\r
  97   <td class="tabledata">OutputModule</td>\r
  98   <td class="tabledata">Specifies the name of the module. A setting of “on” means the user should have permission to use the output module.</td>\r
  99  </tr>\r
 100 </table>\r
 101 <br><br>\r
 102 ExportModule Data Type Hash:\r
 103 <br><br>\r
 104 <table class="infotable">\r
 105  <tr>\r
 106   <td class="tableheading">Setting</td>\r
 107   <td class="tableheading">Description</td>\r
 108  </tr>\r
 109  <tr>\r
 110   <td class="tabledata">ExportModule</td>\r
 111   <td class="tabledata">Specifies the name of the module. A setting of “on” means the user should have permission to use the export module.</td>\r
 112  </tr>\r
 113 </table>\r
 114                 </div>\r
 115         </body>\r
 116 </html>\r