|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UsersResource
Method Summary | |
---|---|
ApiUserList |
createUsers(ApiUserList users)
Creates a list of users. |
ApiUser |
deleteUser(String userName)
Deletes a user from the system. |
ApiUser |
readUser(String userName)
Returns detailed information about a user. |
ApiUserList |
readUsers(DataView dataView)
Returns a list of the user names configured in the system. |
ApiUser |
updateUser(String userName,
ApiUser user)
Updates the given user's information. |
Method Detail |
---|
@Path(value="/") ApiUserList createUsers(ApiUserList users)
When creating new users, the password property of each user should be their plain text password. The returned user information will not contain any password information.
users
- List of users to create.
@Path(value="/{userName}") ApiUser deleteUser(String userName)
userName
- The name of the user to delete.
@Path(value="/{userName}") ApiUser readUser(String userName)
userName
- The user to read.
@Path(value="/") ApiUserList readUsers(DataView dataView)
@Path(value="/{userName}") ApiUser updateUser(String userName, ApiUser user)
userName
- User name being updated.user
- The user information.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |