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

Interface UserService

All Superinterfaces:

AnyService<UserTO,UserPatch>, JAXRSService

@Path(value="users")
public interface UserService
extends AnyService<UserTO,UserPatch>

REST operations for users.

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
javax.ws.rs.core.Response	create(UserTO userTO, boolean storePassword) Creates a new user.
javax.ws.rs.core.Response	status(StatusPatch statusPatch) Performs a status update on given.

Methods inherited from interface org.apache.syncope.common.rest.api.service.AnyService

associate, bulk, create, deassociate, delete, delete, read, read, read, search, update, update, update

Method Detail

create

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

Creates a new user.

Parameters:

userTO - user to be created

storePassword - whether password shall be stored internally

Returns:

Response object featuring Location header of created user as well as the user itself enriched with propagation status information - ProvisioningResult as Entity

status

@POST
 @Path(value="{key}/status")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
javax.ws.rs.core.Response status(@NotNull
                                                                                                                                                                                      StatusPatch statusPatch)

Performs a status update on given.

Parameters:

statusPatch - status update details

Returns:

Response object featuring the updated user enriched with propagation status information - ProvisioningResult as Entity