Documentation/English (British)/developer-chapter3-userauth.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.15 userauth</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.15 userauth</span>\r
  19 <br><br>\r
  20 Authenticates a user. Return a value of 1 and the seed value if the user has been authenticated correctly. If a valid seed has been passed along with the user then it will return a value of 1. Invalid authentications will return a value of 0.\r
  21 <br><br>\r
  22 <b>Parameters:</b>\r
  23 <br><br>\r
  24 <div class="code">\r
  25 $xestiascan_authmodule->userauth(type, user, password, keeploggedin);\r
  26 </div>\r
  27 <br><br>\r
  28 <b>Usage:</b>\r
  29 <br><br>\r
  30 <div class="code">\r
  31 $login = $xestiascan_authmodule->userauth(“password”, “User”, “moo”, 1);\r
  32 $login = $xestiascan_authmodule->userauth(“seed”, “User”, “seed”);\r
  33 </div>\r
  34 <br><br>\r
  35 <i>type</i><br>\r
  36 Specifies the type of authentication. Either Password (passes a password to the userauth module) or Seed (passes a seed for a user who is already logged in).\r
  37 <br><br>\r
  38 <i>user</i><br>\r
  39 Specifies the username to authenticate.\r
  40 <br><br>\r
  41 <i>password</i><br>\r
  42 Specifies the password or seed to use.\r
  43 <br><br>\r
  44 <i>keeploggedin</i><br>\r
  45 Specifies if the user is to keep logged in. By default the user is logged in for three hours but this option will keep the user logged in for one year.\r
  46                 </div>\r
  47         </body>\r
  48 </html>\r