org.apache.syncope.common.rest.api.service

Interface UserSelfService

All Superinterfaces:

JAXRSService

@Path(value="users/self")
public interface UserSelfService
extends JAXRSService

REST operations for user self-management.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
void	confirmPasswordReset(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(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(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(StatusPatch statusPatch) Self-perform a status update.
javax.ws.rs.core.Response	update(UserPatch patch) Self-updates user.
javax.ws.rs.core.Response	update(UserTO user) Self-updates user.

Method Detail

read

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response read()

Returns the user making the service call.

Returns:

calling user data, including own UUID and entitlements

create

@POST
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                                                                                                                                                                               UserTO userTO,
                                                                                                                                                                                               @DefaultValue(value="true") @QueryParam(value="storePassword")
                                                                                                                                                                                               boolean storePassword)

Self-registration for new user.

Parameters:

userTO - user to be created

storePassword - whether password shall be stored internally

Returns:

Response object featuring Location header of self-registered user as well as the user itself enriched with propagation status information

update

@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
                                                                                                                                                                                                              UserPatch patch)

Self-updates user.

Parameters:

patch - modification to be applied to self

Returns:

Response object featuring the updated user

update

@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
                                                                                                                                                                                                                    UserTO user)

Self-updates user.

Parameters:

user - complete update

Returns:

Response object featuring the updated user

status

@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
                                                                                                                                                                                                                            StatusPatch statusPatch)

Self-perform a status update.

Parameters:

statusPatch - status update details

Returns:

Response object featuring the updated user enriched with propagation status information

delete

@DELETE
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response delete()

Self-deletes user.

Returns:

Response object featuring the deleted user

mustChangePassword

@POST
 @Path(value="mustChangePassword")
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response mustChangePassword(String password)

Changes own password when change was forced by an administrator.

Parameters:

password - the password value to update

Returns:

Response object featuring the updated user

requestPasswordReset

@POST
 @Path(value="requestPasswordReset")
 @Produces(value={"application/json","application/yaml","application/xml"})
void requestPasswordReset(@NotNull @QueryParam(value="username")
                                                                                                                                                 String username,
                                                                                                                                                 String securityAnswer)

Provides answer for the security question configured for user matching the given username, if any. If provided answer matches the one stored for that user, a password reset token is internally generated, otherwise an error is returned.

Parameters:

username - username for which the security answer is provided

securityAnswer - actual answer text

confirmPasswordReset

@POST
 @Path(value="confirmPasswordReset")
 @Produces(value={"application/json","application/yaml","application/xml"})
void confirmPasswordReset(@NotNull @QueryParam(value="token")
                                                                                                                                                 String token,
                                                                                                                                                 String password)

Reset the password value for the user matching the provided token, if available and still valid. If the token actually matches one of users, and if it is still valid at the time of submission, the matching user's password value is set as provided. The new password value will need anyway to comply with all relevant password policies.

Parameters:

token - password reset token

password - new password to be set