org.graylog2.rest.resources.users

Class UsersResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.users.UsersResource

@Path(value="/users")
@Consumes(value="application/json")
@Produces(value="application/json")
public class UsersResource
extends RestResource

Field Summary

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

objectMapper, serverStatus

Constructor Summary

Constructors

Constructor and Description
UsersResource(UserService userService, AccessTokenService accessTokenService, Configuration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
void	changePassword(String username, ChangePasswordRequest cr)
void	changeUser(String username, ChangeUserRequest cr)
javax.ws.rs.core.Response	create(CreateUserRequest cr)
void	deletePermissions(String username)
void	deleteUser(String username)
void	editPermissions(String username, PermissionEditRequest permissionRequest)
Token	generateNewToken(String username, String name)
User	get(String username)
TokenList	listTokens(String username)
UserList	listUsers()
void	revokeToken(String username, String token)
void	savePreferences(String username, UpdateUserPreferences preferencesRequest)

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

bytesToValueMap, checkPermission, checkPermission, getCurrentUser, getSubject, guessContentType, isPermitted, isPermitted, page, restrictToMaster, setPrettyPrint

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersResource

@Inject
public UsersResource(UserService userService,
                    AccessTokenService accessTokenService,
                    Configuration configuration)

Method Detail

get

@GET
@Path(value="{username}")
public User get(@PathParam(value="username")
                String username)

listUsers

@GET
public UserList listUsers()

create

@POST
public javax.ws.rs.core.Response create(@NotNull
                                    CreateUserRequest cr)
                                 throws ValidationException

Throws:

ValidationException

changeUser

@PUT
@Path(value="{username}")
public void changeUser(@PathParam(value="username")
                       String username,
                       @NotNull
                       ChangeUserRequest cr)
                throws ValidationException

Throws:

ValidationException

deleteUser

@DELETE
@Path(value="{username}")
public void deleteUser(@PathParam(value="username")
                          String username)

editPermissions

@PUT
@Path(value="{username}/permissions")
public void editPermissions(@PathParam(value="username")
                            String username,
                            @NotNull
                            PermissionEditRequest permissionRequest)
                     throws ValidationException

Throws:

ValidationException

savePreferences

@PUT
@Path(value="{username}/preferences")
public void savePreferences(@PathParam(value="username")
                            String username,
                            UpdateUserPreferences preferencesRequest)
                     throws ValidationException

Throws:

ValidationException

deletePermissions

@DELETE
@Path(value="{username}/permissions")
public void deletePermissions(@PathParam(value="username")
                                 String username)
                       throws ValidationException

Throws:

ValidationException

changePassword

@PUT
@Path(value="{username}/password")
public void changePassword(@PathParam(value="username")
                           String username,
                           ChangePasswordRequest cr)
                    throws ValidationException

Throws:

ValidationException

listTokens

@GET
@Path(value="{username}/tokens")
public TokenList listTokens(@PathParam(value="username")
                            String username)

generateNewToken

@POST
@Path(value="{username}/tokens/{name}")
public Token generateNewToken(@PathParam(value="username")
                               String username,
                               @PathParam(value="name")
                               String name)

revokeToken

@DELETE
@Path(value="{username}/tokens/{token}")
public void revokeToken(@PathParam(value="username")
                           String username,
                           @PathParam(value="token")
                           String token)