security/doc/services-api.txt

   1 Security RIA API
   2
   3 ******************
   4 USERS
   5 ******************
   6 getUsersList.security
   7 > param : getNatures <true|false>
   8 > return : users[] <json> : containing username and roles, and depending on the value of getNatures, the natures.
   9
  10 userExists.security
  11 > param : userName <string>
  12
  13 deleteUser.security
  14 > param : userName <string>
  15
  16 getUserDetails.security
  17 > param : userName <string>
  18 > return : userDetails <json> : full details (roles, natures, etc).
  19
  20 createUser.security
  21 > params : userName <string>, password <string>
  22
  23 updateUserPassword.security
  24 > param : userName <string>, password <string>, [oldpassword <string>] (depends on the admin being logged in or not)
  25
  26
  27 ******************
  28 ROLES
  29 ******************
  30 getRolesList.security
  31 > param : aucun
  32 > return : roles[] <json>
  33
  34 getUsersForRole.security
  35 > param : roleName <string>, getNatures <true|false>
  36 > return : users[] <json> (username and eventually natures)
  37
  38 createRole.security
  39 > param : roleName  <string>
  40
  41 deleteRole.security
  42 > param : roleName  <string>
  43
  44
  45 ************************
  46 LINKS & NATURES
  47 ************************
  48 updateUserRoleLink.security
  49 > params : <string> roleName,  <string> username, <string> action="set|unset"
  50
  51 createUserNature.security
  52 > params : natureObject <json>, userName <string>
  53 > returns : new uuid
  54
  55 deleteUserNature.security
  56 > params : natureUuid <string>
  57
  58 updateUserNature.security
  59 > params : natureUuid <string>, natureObject <json>