UserService Resource
- ./userService/createAdminUser
- ./userService/createGuestUser
- ./userService/createUser
- ./userService/deleteUser/{userName}
- ./userService/getCurrentUserOperations
- ./userService/getCurrentUserPermissions
- ./userService/getGuestUser
- ./userService/getUser/{userName}
- ./userService/getUserOperations/{userName}
- ./userService/getUserPermissions/{userName}
- ./userService/getUsers
- ./userService/isAdminUserExists
- ./userService/lockUser/{username}
- ./userService/passwordChangeNotRequired/{username}
- ./userService/passwordChangeRequired/{username}
- ./userService/ping
- ./userService/registerUser
- ./userService/removeFromCache/{userName}
- ./userService/resetPassword
- ./userService/unlockUser/{username}
- ./userService/updateMe
- ./userService/updateUser
- ./userService/validateKey/{key}
POST /userService/createAdminUser
will create admin user only if not exists !! if exists will return false
media type | data type |
---|---|
application/json | (custom) |
application/xml | user (XML) |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
GET /userService/createGuestUser
media type | data type |
---|---|
application/json | (custom) |
application/xml | user (XML) |
text/plain | (custom) |
POST /userService/createUser
media type | data type |
---|---|
application/json | (custom) |
application/xml | user (XML) |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
GET /userService/deleteUser/{userName}
name | type | description | default |
---|---|---|---|
userName | path | n/a |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
- Available Since
- 1.4
GET /userService/getCurrentUserOperations
- Available Since
- 1.4
media type | data type |
---|---|
application/json | (custom) |
application/xml | list of operation (XML) |
text/plain | (custom) |
- Available Since
- 1.4
GET /userService/getCurrentUserPermissions
- Available Since
- 1.4
media type | data type |
---|---|
application/json | (custom) |
application/xml | list of permission (XML) |
text/plain | (custom) |
GET /userService/getGuestUser
media type | data type |
---|---|
application/json | (custom) |
application/xml | user (XML) |
text/plain | (custom) |
GET /userService/getUser/{userName}
name | type | description | default |
---|---|---|---|
userName | path | n/a |
media type | data type |
---|---|
application/json | (custom) |
application/xml | user (XML) |
- Available Since
- 1.4
GET /userService/getUserOperations/{userName}
- Available Since
- 1.4
name | type | description | default |
---|---|---|---|
userName | path | n/a |
media type | data type |
---|---|
application/json | (custom) |
application/xml | list of operation (XML) |
text/plain | (custom) |
- Available Since
- 1.4
GET /userService/getUserPermissions/{userName}
- Available Since
- 1.4
name | type | description | default |
---|---|---|---|
userName | path | n/a |
media type | data type |
---|---|
application/json | (custom) |
application/xml | list of permission (XML) |
text/plain | (custom) |
GET /userService/getUsers
media type | data type |
---|---|
application/json | (custom) |
application/xml | list of user (XML) |
GET /userService/isAdminUserExists
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
- Available Since
- 2.0
GET /userService/lockUser/{username}
- Available Since
- 2.0
name | type | description | default |
---|---|---|---|
username | path | n/a |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
- Available Since
- 2.0
GET /userService/passwordChangeNotRequired/{username}
- Available Since
- 2.0
name | type | description | default |
---|---|---|---|
username | path | n/a |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
- Available Since
- 2.0
GET /userService/passwordChangeRequired/{username}
- Available Since
- 2.0
name | type | description | default |
---|---|---|---|
username | path | n/a |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
GET /userService/ping
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
- Available Since
- 1.4
POST /userService/registerUser
if redback is not configured for email validation is required, -1 is returned as key
- Available Since
- 1.4
media type | data type |
---|---|
application/xml | userRegistrationRequest (XML) |
media type | data type |
---|---|
application/json | (custom) |
application/xml | registrationKey (XML) |
GET /userService/removeFromCache/{userName}
name | type | description | default |
---|---|---|---|
userName | path | n/a |
media type | data type |
---|---|
application/json | (custom) |
application/xml | int (XML) |
text/plain | (custom) |
- Available Since
- 1.4
POST /userService/resetPassword
- Available Since
- 1.4
media type | data type | description |
---|---|---|
application/json | (custom) | contains username for send a password reset email |
application/xml | resetPasswordRequest (XML) |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
- Available Since
- 2.0
GET /userService/unlockUser/{username}
- Available Since
- 2.0
name | type | description | default |
---|---|---|---|
username | path | n/a |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
- Available Since
- 1.4
POST /userService/updateMe
update only the current user and this fields: fullname, email, password. the service verify the curent logged user with the one passed in the method
- Available Since
- 1.4
media type | data type |
---|---|
application/xml | user (XML) |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
POST /userService/updateUser
media type | data type |
---|---|
application/xml | user (XML) |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |
- Available Since
- 1.4
GET /userService/validateKey/{key}
validate the key and the user with forcing a password change for next login. http session is created.
- Available Since
- 1.4
name | type | description | default |
---|---|---|---|
key | path | authentication key | n/a |
media type | data type |
---|---|
application/json | (custom) |
application/xml | boolean (XML) |
text/plain | (custom) |