Documentation/English (British)/developer-chapter3-getpermissions.html

   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.11 getpermissions</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.11 getpermissions</span>\r
  19 <br><br>\r
  20 Gets the permissions for specific scanner or module. Not specifying a permission name will get the complete list of permissions for that type as a hash. \r
  21 <br><br>\r
  22 Specifying a permission name will return a string saying 1 (the user has permission for that) or 0 (the user does not have permission to do that).\r
  23 <br><br>\r
  24 <b>Parameters:</b>\r
  25 <br><br>\r
  26 <div class="code">\r
  27 $xestiascan_authmodule->getpermissions(options);\r
  28 </div>\r
  29 <br><br>\r
  30 <b>Usage:</b>\r
  31 <br><br>\r
  32 <div class="code">\r
  33 $xestiascan_authmodule->getpermissions({Username => “User”, PermissionType => “OutputModule”, PermissionName => “Test”});<br>\r
  34 %userinfo = $xestiascan_authmodule->getpermissions({ Username => “User”, PermissionType => “UserInfo”);\r
  35 </div>\r
  36 <br><br>\r
  37 <i>options</i><br>\r
  38 Specifies the following options as a hash.\r
  39 <br><br>\r
  40 <table class="infotable">\r
  41  <tr>\r
  42   <td class="tableheading">Setting</td>\r
  43   <td class="tableheading">Description</td>\r
  44  </tr>\r
  45  <tr>\r
  46   <td class="tabledata">Username</td>\r
  47   <td class="tabledata">Specifies the username to get permissions for.</td>\r
  48  </tr>\r
  49  <tr>\r
  50   <td class="tabledata">PermissionType</td>\r
  51   <td class="tabledata">Specifies the permission type.</td>\r
  52  </tr>\r
  53  <tr>\r
  54   <td class="tabledata">PermissionName</td>\r
  55   <td class="tabledata">Get a specific permission name.</td>\r
  56  </tr>\r
  57 </table>\r
  58                 </div>\r
  59         </body>\r
  60 </html>\r