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

Interface UserService

All Superinterfaces:

AnyService<UserTO>, JAXRSService

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

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.
UserTO	read(String key) Reads the any object matching the provided key.
PagedResult<UserTO>	search(AnyQuery anyQuery) Returns a paged list of any objects matching the given query.
javax.ws.rs.core.Response	status(StatusPatch statusPatch) Performs a status update on given user.
javax.ws.rs.core.Response	update(UserPatch userPatch) Updates user matching the provided key.
javax.ws.rs.core.Response	update(UserTO userTO) Updates user matching the provided key.

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

associate, bulk, deassociate, delete, delete, read, read, update

Method Detail

read

UserTO read(String key)

Description copied from interface: AnyService

Reads the any object matching the provided key.

Specified by:

read in interface AnyService<UserTO>

Parameters:

key - if value looks like a UUID then it is interpreted as key, otherwise as a (user)name

Returns:

any object with matching key

search

PagedResult<UserTO> search(AnyQuery anyQuery)

Description copied from interface: AnyService

Returns a paged list of any objects matching the given query.

Specified by:

search in interface AnyService<UserTO>

Parameters:

anyQuery - query conditions

Returns:

paged list of any objects matching the given query

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)

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

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 userPatch)

Updates user matching the provided key.

Parameters:

userPatch - modification to be applied to user matching the provided key

Returns:

Response object featuring the updated user enriched with propagation status information

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 userTO)

Updates user matching the provided key.

Parameters:

userTO - complete update

Returns:

Response object featuring the updated user enriched with propagation status information

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)

Performs a status update on given user.

Parameters:

statusPatch - status update details

Returns:

Response object featuring the updated user enriched with propagation status information