projects
/
lgpl
/
argeo-commons.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Fix issue with LDAP context cast
[lgpl/argeo-commons.git]
/
security
/
doc
/
services-api.txt
diff --git
a/security/doc/services-api.txt
b/security/doc/services-api.txt
index 2751d60323a3c842cba2e8711048183db5f1e1f3..bdb8d423ba22570bed244c363b90e489d700a486 100644
(file)
--- a/
security/doc/services-api.txt
+++ b/
security/doc/services-api.txt
@@
-3,25
+3,34
@@
Security RIA API
******************
USERS
******************
******************
USERS
******************
+getCredentials.security
+> return : userDetails <json> of the logged user
+
getUsersList.security
> param : getNatures <true|false>
> return : users[] <json> : containing username and roles, and depending on the value of getNatures, the natures.
userExists.security
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 : user
N
ame <string>
+> param : user
n
ame <string>
-deleteUser.security
-> param : user
N
ame <string>
+deleteUser.security
(ADMIN only)
+> param : user
n
ame <string>
getUserDetails.security
> param : userName <string>
> return : userDetails <json> : full details (roles, natures, etc).
getUserDetails.security
> param : userName <string>
> return : userDetails <json> : full details (roles, natures, etc).
-createUser.security
-> params : userName <string>, password <string>
+createUser.security (ADMIN only, POST)
+> params : userDetails <json>
+
+updateUser.security (POST)
+> params : userDetails <json>
+
+updateUserPassword.security (ADMIN only)
+> param : username <string>, password <string>
-update
User
Password.security
-> param :
userName <string>, password <string>, [oldpassword <string>] (depends on the admin being logged in or not)
+updatePassword.security
+> param :
password <string>, oldpassword <string>
******************
******************
@@
-29,31
+38,31
@@
ROLES
******************
getRolesList.security
> param : aucun
******************
getRolesList.security
> param : aucun
-> return : roles[] <
json
>
+> return : roles[] <
string
>
-getUsersForRole.security
+
#
getUsersForRole.security
> param : roleName <string>, getNatures <true|false>
> return : users[] <json> (username and eventually natures)
> param : roleName <string>, getNatures <true|false>
> return : users[] <json> (username and eventually natures)
-createRole.security
-> param : role
Name
<string>
+createRole.security
(ADMIN only)
+> param : role <string>
-deleteRole.security
-> param : roleName <string>
+deleteRole.security (ADMIN only)
+> param : role <string>
+
+#updateUserRoleLink.security
+> params : <string> roleName, <string> username, <string> action="set|unset"
************************
LINKS & NATURES
************************
************************
LINKS & NATURES
************************
-updateUserRoleLink.security
-> params : <string> roleName, <string> username, <string> action="set|unset"
-createUserNature.security
+
#
createUserNature.security
> params : natureObject <json>, userName <string>
> params : natureObject <json>, userName <string>
-> returns : new uuid
-deleteUserNature.security
-> params : nature
Uuid
<string>
+
#
deleteUserNature.security
+> params : nature
Object <json>, userName
<string>
-updateUserNature.security
-> params : nature
Uuid <string>, natureObject <json
>
\ No newline at end of file
+
#
updateUserNature.security
+> params : nature
Object <json>, userName <string
>
\ No newline at end of file