de.cinovo.cloudconductor.api.interfaces

Interface IUser

@Path(value="/user")
 @Produces(value="application/json;charset=UTF-8")
 @Consumes(value="application/json;charset=UTF-8")
public interface IUser

Copyright 2017 Cinovo AG

Author:

psigloch

Method Summary

Modifier and Type	Method and Description
void	changePassword(PasswordChange pwChange)
User	createAuthToken(java.lang.String userName)
void	delete(java.lang.String userName)
User	getUser(java.lang.String userName)
User[]	getUsers()
void	revokeAuthToken(java.lang.String userName, java.lang.String token)
void	save(User user)

Method Detail

getUsers

@GET
 @RolesAllowed(value={"VIEW_USERS","EDIT_USERS"})
User[] getUsers()

Returns:

list of users

save

@PUT
 @RolesAllowed(value="EDIT_USERS")
void save(User user)

Parameters:

user - the user to save

getUser

@GET
 @Path(value="/{username}")
 @RolesAllowed(value={"VIEW_USERS","EDIT_USERS"})
User getUser(@PathParam(value="username")
                                                                                                java.lang.String userName)

Parameters:

userName - the user name

Returns:

the requested user

delete

@DELETE
 @Path(value="/{username}")
 @RolesAllowed(value="EDIT_USERS")
void delete(@PathParam(value="username")
                                                                                   java.lang.String userName)

Parameters:

userName - the user name

createAuthToken

@PUT
 @Path(value="/{username}/authtoken")
 @RolesAllowed(value="EDIT_USERS")
 @Consumes(value={"text/plain","application/json;charset=UTF-8"})
 @Produces(value="application/json;charset=UTF-8")
User createAuthToken(@PathParam(value="username")
                                                                                                                                                                                                                        java.lang.String userName)

Parameters:

userName - the user name

Returns:

the user

revokeAuthToken

@DELETE
 @Path(value="/{username}/authtoken/{token}")
 @RolesAllowed(value="EDIT_USERS")
void revokeAuthToken(@PathParam(value="username")
                                                                                                              java.lang.String userName,
                                                                                                              @PathParam(value="token")
                                                                                                              java.lang.String token)

Parameters:

userName - the user name

token - the token to revoke

changePassword

@PUT
 @Path(value="/changepassword")
void changePassword(PasswordChange pwChange)

Parameters:

pwChange - the password change request