Introduce API

git-svn-id: https://svn.argeo.org/commons/trunk@2922 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc

diff --git a/security/doc/services-api.txt b/security/doc/services-api.txt
new file mode 100644 (file)
index 0000000..9f2dfdc
--- /dev/null
+++ b/security/doc/services-api.txt
@@ -0,0 +1,62 @@
+Security RIA API
+
+******************
+USERS
+******************
+getUsersList.security
+> param : getNatures <true|false>
+> return : users[] <json> : containing username and roles, and depending on the value of getNatures, the natures.
+
+userExists.security
+> param : userName <string>
+
+deleteUser.security
+> param : userName <string>
+
+getUserDetails.security
+> param : userName <string>
+> return : userDetails <json> : full details (roles, natures, etc).
+
+createUser.security
+> params : userName <string>, password <string> 
+
+updateUserNature.security
+> param : userName <string>,  userDetails <json>
+
+updateUserPassword.security
+> param : userName <string>, password <string>, [oldpassword <string>] (depends on the admin being logged in or not)
+
+
+******************
+ROLES
+******************
+getRolesList.security
+> param : aucun
+> return : roles[] <json>
+
+getUsersForRole.security
+> param : roleName <string>, getNatures <true|false>
+> return : users[] <json> (username and eventually natures)
+
+createRole.security
+> param : roleName  <string>
+
+deleteRole.security
+> param : roleName  <string>
+
+
+************************
+LINKS & NATURES
+************************
+updateUserRoleLink.security
+> params : <string> roleName,  <string> username, <string> action="set|unset"
+
+createUserNature.security
+> params : natureObject <json>, userName <string>
+> returns : new uuid
+
+deleteUserNature.security
+> params : natureUuid <string>
+
+updateUserNature.security
+> params : natureUuid <string>, natureObject <json>
\ No newline at end of file