org.apache.syncope.common.services

Interface UserService

All Superinterfaces:

JAXRSService

@Path(value="users")
public interface UserService
extends JAXRSService

REST operations for users.

Field Summary

Fields inherited from interface org.apache.syncope.common.services.JAXRSService

DEFAULT_PARAM_PAGE, DEFAULT_PARAM_PAGE_VALUE, DEFAULT_PARAM_SIZE, DEFAULT_PARAM_SIZE_VALUE, PARAM_DETAILS, PARAM_FIQL, PARAM_ORDERBY, PARAM_PAGE, PARAM_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
BulkActionResult	bulk(BulkAction bulkAction) Executes the provided bulk action.
javax.ws.rs.core.Response	bulkAssociation(Long userId, ResourceAssociationActionType type, ResourceAssociationMod associationMod) Executes resource-related operations on given user.
javax.ws.rs.core.Response	bulkDeassociation(Long userId, ResourceDeassociationActionType type, List<ResourceName> resourceNames) Executes resource-related operations on given user.
javax.ws.rs.core.Response	create(UserTO userTO, boolean storePassword) Creates a new user.
javax.ws.rs.core.Response	delete(Long userId) Deletes user matching provided userId.
javax.ws.rs.core.Response	getUserId(String username) Gives the user id for the provided username.
javax.ws.rs.core.Response	getUsername(Long userId) Gives the username for the provided user id.
PagedResult<UserTO>	list() Returns a paged list of existing users.
PagedResult<UserTO>	list(Integer page, Integer size) Returns a paged list of existing users matching page/size conditions.
PagedResult<UserTO>	list(Integer page, Integer size, String orderBy, boolean details) Returns a paged list of existing users matching page/size conditions.
PagedResult<UserTO>	list(String orderBy) Returns a paged list of existing users.
UserTO	read(Long userId) Reads the user matching the provided userId.
PagedResult<UserTO>	search(String fiql) Returns a paged list of users matching the provided FIQL search condition.
PagedResult<UserTO>	search(String fiql, Integer page, Integer size) Returns a paged list of users matching the provided FIQL search condition.
PagedResult<UserTO>	search(String fiql, Integer page, Integer size, String orderBy, boolean details) Returns a paged list of users matching the provided FIQL search condition.
PagedResult<UserTO>	search(String fiql, String orderBy) Returns a paged list of users matching the provided FIQL search condition.
javax.ws.rs.core.Response	status(Long userId, StatusMod statusMod) Performs a status update on user matching provided userId.
javax.ws.rs.core.Response	update(Long userId, UserMod userMod) Updates user matching the provided userId.

Method Detail

getUsername

@OPTIONS
@Path(value="{userId}/username")
javax.ws.rs.core.Response getUsername(@NotNull@PathParam(value="userId")
                                                 Long userId)

Gives the username for the provided user id.

Parameters:

userId - user id

Returns:

Response object featuring HTTP header with username matching the given userId

getUserId

@OPTIONS
@Path(value="{username}/userId")
javax.ws.rs.core.Response getUserId(@NotNull@PathParam(value="username")
                                               String username)

Gives the user id for the provided username.

Parameters:

username - username

Returns:

Response object featuring HTTP header with userId matching the given username

read

@GET
@Path(value="{userId}")
@Produces(value={"application/xml","application/json"})
UserTO read(@NotNull@PathParam(value="userId")
                            Long userId)

Reads the user matching the provided userId.

Parameters:

userId - id of user to be read

Returns:

User matching the provided userId

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> list()

Returns a paged list of existing users.

Returns:

paged list of all existing users

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> list(@QueryParam(value="orderby")
                                    String orderBy)

Returns a paged list of existing users.

Parameters:

orderBy - list of ordering clauses, separated by comma

Returns:

paged list of all existing users

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> list(@NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                    Integer page,
                                    @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                    Integer size)

Returns a paged list of existing users matching page/size conditions.

Parameters:

page - result page number

size - number of entries per page

Returns:

paged list of existing users matching page/size conditions

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> list(@NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                    Integer page,
                                    @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                    Integer size,
                                    @QueryParam(value="orderby")
                                    String orderBy,
                                    @QueryParam(value="details")@DefaultValue(value="true")
                                    boolean details)

Returns a paged list of existing users matching page/size conditions.

Parameters:

page - result page number

size - number of entries per page

orderBy - list of ordering clauses, separated by comma

details - whether include all details or not, defaults to true

Returns:

paged list of existing users matching page/size conditions

search

@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> search(@NotNull@QueryParam(value="fiql")
                                           String fiql)

Returns a paged list of users matching the provided FIQL search condition.

Parameters:

fiql - FIQL search expression

Returns:

paged list of users matching the provided FIQL search condition

search

@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> search(@NotNull@QueryParam(value="fiql")
                                           String fiql,
                                           @QueryParam(value="orderby")
                                           String orderBy)

Returns a paged list of users matching the provided FIQL search condition.

Parameters:

fiql - FIQL search expression

orderBy - list of ordering clauses, separated by comma

Returns:

paged list of users matching the provided FIQL search condition

search

@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> search(@QueryParam(value="fiql")
                                           String fiql,
                                           @NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                           Integer page,
                                           @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                           Integer size)

Returns a paged list of users matching the provided FIQL search condition.

Parameters:

fiql - FIQL search expression

page - result page number

size - number of entries per page

Returns:

paged list of users matching the provided FIQL search condition

search

@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> search(@QueryParam(value="fiql")
                                           String fiql,
                                           @NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                           Integer page,
                                           @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                           Integer size,
                                           @QueryParam(value="orderby")
                                           String orderBy,
                                           @QueryParam(value="details")@DefaultValue(value="true")
                                           boolean details)

Returns a paged list of users matching the provided FIQL search condition.

Parameters:

fiql - FIQL search expression

page - result page number

size - number of entries per page

orderBy - list of ordering clauses, separated by comma

details - whether include all details or not, defaults to true

Returns:

paged list of users matching the provided FIQL search condition

create

@POST
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
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 - UserTO as Entity

update

@POST
@Path(value="{userId}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response update(@NotNull@PathParam(value="userId")
                                                           Long userId,
                                                           @NotNull
                                                           UserMod userMod)

Updates user matching the provided userId.

Parameters:

userId - id of user to be updated

userMod - modification to be applied to user matching the provided userId

Returns:

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

status

@POST
@Path(value="{userId}/status")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response status(@NotNull@PathParam(value="userId")
                                                           Long userId,
                                                           @NotNull
                                                           StatusMod statusMod)

Performs a status update on user matching provided userId.

Parameters:

userId - id of user to be subjected to status update

statusMod - status update details

Returns:

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

delete

@DELETE
@Path(value="{userId}")
@Produces(value={"application/xml","application/json"})
javax.ws.rs.core.Response delete(@NotNull@PathParam(value="userId")
                                                    Long userId)

Deletes user matching provided userId.

Parameters:

userId - id of user to be deleted

Returns:

Response object featuring the deleted user enriched with propagation status information - UserTO as Entity

bulkDeassociation

@POST
@Path(value="{userId}/bulkDeassociation/{type}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response bulkDeassociation(@NotNull@PathParam(value="userId")
                                                                      Long userId,
                                                                      @NotNull@PathParam(value="type")
                                                                      ResourceDeassociationActionType type,
                                                                      @NotNull
                                                                      List<ResourceName> resourceNames)

Executes resource-related operations on given user.

Parameters:

userId - user id

type - resource de-association action type

resourceNames - external resources to be used for propagation-related operations

Returns:

Response object featuring BulkActionResult as Entity

bulkAssociation

@POST
@Path(value="{userId}/bulkAssociation/{type}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response bulkAssociation(@NotNull@PathParam(value="userId")
                                                                    Long userId,
                                                                    @NotNull@PathParam(value="type")
                                                                    ResourceAssociationActionType type,
                                                                    @NotNull
                                                                    ResourceAssociationMod associationMod)

Executes resource-related operations on given user.

Parameters:

userId - user id.

type - resource association action type

associationMod - external resources to be used for propagation-related operations

Returns:

Response object featuring BulkActionResult as Entity

bulk

@POST
@Path(value="bulk")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
BulkActionResult bulk(@NotNull
                                                BulkAction bulkAction)

Executes the provided bulk action.

Parameters:

bulkAction - list of user ids against which the bulk action will be performed.

Returns:

Bulk action result