@Path(value="users/self") public interface UserSelfService extends JAXRSService
CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER
Modifier and Type | Method and Description |
---|---|
void |
confirmPasswordReset(@NotNull String token,
String password)
Reset the password value for the user matching the provided token, if available and still valid.
|
javax.ws.rs.core.Response |
create(@NotNull UserTO userTO,
boolean storePassword)
Self-registration for new user.
|
javax.ws.rs.core.Response |
delete()
Self-deletes user.
|
javax.ws.rs.core.Response |
mustChangePassword(String password)
Changes own password when change was forced by an administrator.
|
javax.ws.rs.core.Response |
read()
Returns the user making the service call.
|
void |
requestPasswordReset(@NotNull String username,
String securityAnswer)
Provides answer for the security question configured for user matching the given username, if any.
|
javax.ws.rs.core.Response |
status(@NotNull StatusPatch statusPatch)
Self-perform a status update.
|
javax.ws.rs.core.Response |
update(@NotNull UserPatch patch)
Self-updates user.
|
javax.ws.rs.core.Response |
update(@NotNull UserTO user)
Self-updates user.
|
@GET @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response read()
@POST @Produces(value={"application/json","application/yaml","application/xml"}) @Consumes(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response create(@NotNull @NotNull UserTO userTO, @DefaultValue(value="true") @QueryParam(value="storePassword") boolean storePassword)
userTO
- user to be createdstorePassword
- whether password shall be stored internally@PATCH @Path(value="{key}") @Produces(value={"application/json","application/yaml","application/xml"}) @Consumes(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response update(@NotNull @NotNull UserPatch patch)
patch
- modification to be applied to self@PUT @Path(value="{key}") @Produces(value={"application/json","application/yaml","application/xml"}) @Consumes(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response update(@NotNull @NotNull UserTO user)
user
- complete update@POST @Path(value="{key}/status") @Produces(value={"application/json","application/yaml","application/xml"}) @Consumes(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response status(@NotNull @NotNull StatusPatch statusPatch)
statusPatch
- status update details@DELETE @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response delete()
@POST @Path(value="mustChangePassword") @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response mustChangePassword(String password)
password
- the password value to update@POST @Path(value="requestPasswordReset") @Produces(value={"application/json","application/yaml","application/xml"}) void requestPasswordReset(@NotNull @QueryParam(value="username") @NotNull String username, String securityAnswer)
username
- username for which the security answer is providedsecurityAnswer
- actual answer text@POST @Path(value="confirmPasswordReset") @Produces(value={"application/json","application/yaml","application/xml"}) void confirmPasswordReset(@NotNull @QueryParam(value="token") @NotNull String token, String password)
token
- password reset tokenpassword
- new password to be setCopyright © 2010–2023 The Apache Software Foundation. All rights reserved.