Package org.openremote.model.security

Interface UserResource

@Path("user")
public interface UserResource

Manage users in realms and get info of current user.

Method Summary

Modifier and Type	Method	Description
User	create(RequestParams requestParams, String realm, @Valid User user)
void	delete(RequestParams requestParams, String realm, String userId)
void	disconnectUserSession(RequestParams requestParams, String realm, String sessionID)
User	get(RequestParams requestParams, String realm, String userId)
Role[]	getClientRoles(RequestParams requestParams, String realm, String clientId)
User	getCurrent(RequestParams requestParams)
String[]	getCurrentUserClientRoles(RequestParams requestParams, String clientId)
String[]	getCurrentUserRealmRoles(RequestParams requestParams)
String[]	getUserClientRoles(RequestParams requestParams, String realm, String userId, String clientId)
String[]	getUserRealmRoles(RequestParams requestParams, String realm, String userId)
UserSession[]	getUserSessions(RequestParams requestParams, String realm, String userId)
User[]	query(RequestParams requestParams, UserQuery query)
void	resetPassword(RequestParams requestParams, String realm, String userId, Credential credential)
String	resetSecret(RequestParams requestParams, String realm, String userId)
User	update(RequestParams requestParams, String realm, @Valid User user)
void	updateClientRoles(RequestParams requestParams, String realm, Role[] roles, String clientId)
void	updateCurrentUserLocale(RequestParams requestParams, String locale)
void	updateRoles(RequestParams requestParams, String realm, Role[] roles)
void	updateUserClientRoles(RequestParams requestParams, String realm, String userId, String[] roles, String clientId)
void	updateUserRealmRoles(RequestParams requestParams, String realm, String userId, String[] roles)

Method Details

getClientRoles

@GET
@Path("{realm}/{clientId}/roles")
@Produces("application/json")
@RolesAllowed("read:admin")
Role[] getClientRoles(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("clientId")
 String clientId)

updateRoles

@PUT
@Path("{realm}/roles")
@Consumes("application/json")
@RolesAllowed("write:admin")
void updateRoles(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 Role[] roles)

updateClientRoles

@PUT
@Path("{realm}/{clientId}/roles")
@Consumes("application/json")
@RolesAllowed("write:admin")
void updateClientRoles(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 Role[] roles,
 @PathParam("clientId")
 String clientId)

query

@POST
@Consumes("application/json")
@Produces("application/json")
@Path("query")
User[] query(@BeanParam
 RequestParams requestParams,
 UserQuery query)

get

@GET
@Path("{realm}/{userId}")
@Produces("application/json")
User get(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("userId")
 String userId)

getCurrent

@GET
@Path("user")
@Produces("application/json")
User getCurrent(@BeanParam
 RequestParams requestParams)

update

@PUT
@Path("{realm}/users")
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("write:admin")
User update(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @Valid
 @Valid User user)

create

@POST
@Path("{realm}/users")
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("write:admin")
User create(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @Valid
 @Valid User user)

delete

@DELETE
@Path("{realm}/users/{userId}")
@RolesAllowed("write:admin")
void delete(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("userId")
 String userId)

resetPassword

@PUT
@Path("{realm}/reset-password/{userId}")
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("write:admin")
void resetPassword(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("userId")
 String userId,
 Credential credential)

resetSecret

@GET
@Path("{realm}/reset-secret/{userId}")
@Produces("application/json")
@RolesAllowed("write:admin")
String resetSecret(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("userId")
 String userId)

getUserClientRoles

@GET
@Path("{realm}/userRoles/{userId}/{clientId}")
@Produces("application/json")
String[] getUserClientRoles(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("userId")
 String userId,
 @PathParam("clientId")
 String clientId)

getUserRealmRoles

@GET
@Path("{realm}/userRealmRoles/{userId}")
@Produces("application/json")
String[] getUserRealmRoles(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("userId")
 String userId)

getCurrentUserClientRoles

@GET
@Path("userRoles/{clientId}")
@Produces("application/json")
String[] getCurrentUserClientRoles(@BeanParam
 RequestParams requestParams,
 @PathParam("clientId")
 String clientId)

getCurrentUserRealmRoles

@GET
@Path("userRealmRoles")
@Produces("application/json")
String[] getCurrentUserRealmRoles(@BeanParam
 RequestParams requestParams)

updateUserClientRoles

@PUT
@Path("{realm}/userRoles/{userId}/{clientId}")
@Consumes("application/json")
@RolesAllowed("write:admin")
void updateUserClientRoles(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("userId")
 String userId,
 String[] roles,
 @PathParam("clientId")
 String clientId)

updateUserRealmRoles

@PUT
@Path("{realm}/userRealmRoles/{userId}")
@Consumes("application/json")
@RolesAllowed("write:admin")
void updateUserRealmRoles(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("userId")
 String userId,
 String[] roles)

updateCurrentUserLocale

@PUT
@Path("locale")
@Consumes("application/json")
void updateCurrentUserLocale(@BeanParam
 RequestParams requestParams,
 String locale)

getUserSessions

@GET
@Path("{realm}/userSessions/{userId}")
@Produces("application/json")
UserSession[] getUserSessions(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("userId")
 String userId)

disconnectUserSession

@GET
@Path("{realm}/disconnect/{sessionID}")
void disconnectUserSession(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("sessionID")
 String sessionID)