UserService
The following resources are applicable:
- /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}
/userService/createAdminUser
Mount Point: /redbackServices/userService/createAdminUser
POST
will create admin user only if not exists !! if exists will return false
Request Body
| element: | user |
| media types: | application/xml application/json |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/createGuestUser
Mount Point: /redbackServices/userService/createGuestUser
GET
Response Body
| element: | user |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/createUser
Mount Point: /redbackServices/userService/createUser
POST
Request Body
| element: | user |
| media types: | application/xml application/json |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/deleteUser/{userName}
Mount Point: /redbackServices/userService/deleteUser/{userName}
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| userName | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/getCurrentUserOperations
Mount Point: /redbackServices/userService/getCurrentUserOperations
Available Since: 1.4
GET
Available Since: 1.4
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
the current logged user operations, if no logged user guest operations are returned
/userService/getCurrentUserPermissions
Mount Point: /redbackServices/userService/getCurrentUserPermissions
Available Since: 1.4
GET
Available Since: 1.4
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
the current logged user permissions, if no logged user guest permissions are returned
/userService/getGuestUser
Mount Point: /redbackServices/userService/getGuestUser
GET
Response Body
| element: | user |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/getUser/{userName}
Mount Point: /redbackServices/userService/getUser/{userName}
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| userName | (no documentation provided) | path |
Response Body
| element: | user |
| media types: | application/xml application/json |
(no documentation provided)
/userService/getUserOperations/{userName}
Mount Point: /redbackServices/userService/getUserOperations/{userName}
Available Since: 1.4
GET
Available Since: 1.4
Parameters
| name | description | type | default |
|---|---|---|---|
| userName | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/getUserPermissions/{userName}
Mount Point: /redbackServices/userService/getUserPermissions/{userName}
Available Since: 1.4
GET
Available Since: 1.4
Parameters
| name | description | type | default |
|---|---|---|---|
| userName | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/getUsers
Mount Point: /redbackServices/userService/getUsers
GET
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/userService/isAdminUserExists
Mount Point: /redbackServices/userService/isAdminUserExists
GET
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/lockUser/{username}
Mount Point: /redbackServices/userService/lockUser/{username}
Available Since: 2.0
GET
Available Since: 2.0
Parameters
| name | description | type | default |
|---|---|---|---|
| username | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/passwordChangeNotRequired/{username}
Mount Point: /redbackServices/userService/passwordChangeNotRequired/{username}
Available Since: 2.0
GET
Available Since: 2.0
Parameters
| name | description | type | default |
|---|---|---|---|
| username | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/passwordChangeRequired/{username}
Mount Point: /redbackServices/userService/passwordChangeRequired/{username}
Available Since: 2.0
GET
Available Since: 2.0
Parameters
| name | description | type | default |
|---|---|---|---|
| username | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/ping
Mount Point: /redbackServices/userService/ping
GET
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/registerUser
Mount Point: /redbackServices/userService/registerUser
Available Since: 1.4
POST
Available Since: 1.4
if redback is not configured for email validation is required, -1 is returned as key
Request Body
| element: | userRegistrationRequest |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | registrationKey |
| media types: | application/xml application/json |
(no documentation provided)
/userService/removeFromCache/{userName}
Mount Point: /redbackServices/userService/removeFromCache/{userName}
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| userName | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/resetPassword
Mount Point: /redbackServices/userService/resetPassword
Available Since: 1.4
POST
Available Since: 1.4
Request Body
| element: | resetPasswordRequest |
| media types: | application/xml application/json |
contains username for send a password reset email
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/unlockUser/{username}
Mount Point: /redbackServices/userService/unlockUser/{username}
Available Since: 2.0
GET
Available Since: 2.0
Parameters
| name | description | type | default |
|---|---|---|---|
| username | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/updateMe
Mount Point: /redbackServices/userService/updateMe
Available Since: 1.4
POST
Available Since: 1.4
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
Request Body
| element: | user |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/updateUser
Mount Point: /redbackServices/userService/updateUser
POST
Request Body
| element: | user |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/userService/validateKey/{key}
Mount Point: /redbackServices/userService/validateKey/{key}
Available Since: 1.4
GET
Available Since: 1.4
validate the key and the user with forcing a password change for next login. http session is created.
Parameters
| name | description | type | default |
|---|---|---|---|
| key | authentication key | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)