security/doc/services-api.txt

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