de.cinovo.cloudconductor.api.interfaces

Interface IUserGroup

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

Copyright 2017 Cinovo AG

Author:

psigloch

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String userGroupName)
User[]	getGroupMembers(java.lang.String userGroupName)
UserGroup	getUserGroup(java.lang.String userGroupName)
UserGroup[]	getUserGroups()
void	save(UserGroup userGroup)

Method Detail

getUserGroups

@GET
 @RolesAllowed(value={"VIEW_USERS","EDIT_USERS"})
UserGroup[] getUserGroups()

Returns:

list of usergroups

save

@PUT
 @RolesAllowed(value="EDIT_USERS")
void save(UserGroup userGroup)

Parameters:

userGroup - the user group to save

getUserGroup

@GET
 @Path(value="/{usergroupname}")
 @RolesAllowed(value={"VIEW_USERS","EDIT_USERS"})
UserGroup getUserGroup(@PathParam(value="usergroupname")
                                                                                                               java.lang.String userGroupName)

Parameters:

userGroupName - the name of the user group

Returns:

the requested user group

delete

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

Parameters:

userGroupName - the user group name

getGroupMembers

@GET
 @Path(value="/{usergroupname}/members")
 @RolesAllowed(value={"VIEW_USERS","EDIT_USERS"})
User[] getGroupMembers(@PathParam(value="usergroupname")
                                                                                                                       java.lang.String userGroupName)

Parameters:

userGroupName - the usergroup name

Returns:

list of group members