Package org.graylog.security.authzroles

Class AuthzRolesResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog.security.authzroles.AuthzRolesResource

@RequiresAuthentication
@Path("/authz/roles")
@Produces("application/json")
public class AuthzRolesResource
extends RestResource

Field Summary

Fields

Modifier and Type	Field	Description
protected static final com.google.common.collect.ImmutableMap<String,SearchQueryField>	SEARCH_FIELD_MAPPING
protected static final com.google.common.collect.ImmutableMap<String,SearchQueryField>	USER_SEARCH_FIELD_MAPPING

Fields inherited from class org.graylog2.shared.rest.resources.RestResource

configuration

Constructor Summary

Constructors

Constructor	Description
AuthzRolesResource(PaginatedAuthzRolesService authzRolesService, PaginatedUserService paginatedUserService, UserService userService)

Method Summary

Modifier and Type	Method	Description
void	addUser(@NotBlank String roleId, Set<String> usernames)
void	delete(@NotBlank String roleId)
AuthzRoleDTO	get(@NotBlank String roleId)
PaginatedResponse<AuthzRoleDTO>	getList(int page, int perPage, String query, String sort, String order)
PaginatedResponse<AuthzRoleDTO>	getListForUser(@NotEmpty String username, int page, int perPage, String query, String sort, String order)
PaginatedResponse<UserOverviewDTO>	getUsersForRole(@NotEmpty String roleId, int page, int perPage, String query, String sort, String order)
void	removeUser(@NotBlank String roleId, @NotBlank String username)

Methods inherited from class org.graylog2.shared.rest.resources.RestResource

checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getIndexSet, getSubject, getUriBuilderToSelf, isAnyPermitted, isAnyPermitted, isPermitted, isPermitted, setPrettyPrint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SEARCH_FIELD_MAPPING

protected static final com.google.common.collect.ImmutableMap<String,SearchQueryField> SEARCH_FIELD_MAPPING

USER_SEARCH_FIELD_MAPPING

protected static final com.google.common.collect.ImmutableMap<String,SearchQueryField> USER_SEARCH_FIELD_MAPPING

Constructor Details

AuthzRolesResource

@Inject
public AuthzRolesResource(PaginatedAuthzRolesService authzRolesService,
 PaginatedUserService paginatedUserService,
 UserService userService)

Method Details

getList

@GET
@Timed
@RequiresPermissions("roles:read")
public PaginatedResponse<AuthzRoleDTO> getList(@QueryParam("page") @DefaultValue("1")
 int page,
 @QueryParam("per_page") @DefaultValue("50")
 int perPage,
 @QueryParam("query") @DefaultValue("")
 String query,
 @DefaultValue("name") @QueryParam("sort")
 String sort,
 @DefaultValue("asc") @QueryParam("order")
 String order)

getUsersForRole

@GET
@Path("/{roleId}/assignees")
@Produces("application/json")
@RequiresPermissions("users:list")
public PaginatedResponse<UserOverviewDTO> getUsersForRole(@PathParam("roleId") @NotEmpty
 @NotEmpty String roleId,
 @QueryParam("page") @DefaultValue("1")
 int page,
 @QueryParam("per_page") @DefaultValue("50")
 int perPage,
 @QueryParam("query") @DefaultValue("")
 String query,
 @DefaultValue("name") @QueryParam("sort")
 String sort,
 @DefaultValue("asc") @QueryParam("order")
 String order)

get

@GET
@Path("{roleId}")
@Produces("application/json")
public AuthzRoleDTO get(@PathParam("roleId") @NotBlank
 @NotBlank String roleId)

getListForUser

@GET
@Path("/user/{username}")
@RequiresPermissions("roles:read")
public PaginatedResponse<AuthzRoleDTO> getListForUser(@PathParam("username") @NotEmpty
 @NotEmpty String username,
 @QueryParam("page") @DefaultValue("1")
 int page,
 @QueryParam("per_page") @DefaultValue("50")
 int perPage,
 @QueryParam("query") @DefaultValue("")
 String query,
 @DefaultValue("name") @QueryParam("sort")
 String sort,
 @DefaultValue("asc") @QueryParam("order")
 String order)

addUser

@PUT
@Produces("application/json")
@Path("{roleId}/assignees")
public void addUser(@PathParam("roleId") @NotBlank
 @NotBlank String roleId,
 Set<String> usernames)
             throws ValidationException

Throws:

ValidationException

removeUser

@DELETE
@Path("{roleId}/assignee/{username}")
public void removeUser(@PathParam("roleId") @NotBlank
 @NotBlank String roleId,
 @PathParam("username") @NotBlank
 @NotBlank String username)
                throws ValidationException

Throws:

ValidationException

delete

@DELETE
@Path("{roleId}")
@Produces("application/json")
public void delete(@PathParam("roleId") @NotBlank
 @NotBlank String roleId)