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

Interface SecurityQuestionService

All Superinterfaces:

JAXRSService

@Path(value="securityQuestions")
public interface SecurityQuestionService
extends JAXRSService

REST operations for security questions.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(@NotNull SecurityQuestionTO securityQuestionTO) Creates a new security question.
void	delete(@NotNull String key) Deletes the security question matching the provided key.
List<SecurityQuestionTO>	list() Returns a list of all security questions.
SecurityQuestionTO	read(@NotNull String key) Returns security question with matching key.
SecurityQuestionTO	readByUser(@NotNull String username) Ask for security question configured for the user matching the given username, if any.
void	update(@NotNull SecurityQuestionTO securityQuestionTO) Updates the security question matching the provided key.

Method Detail

list

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
List<SecurityQuestionTO> list()

Returns a list of all security questions.

Returns:

list of all security questions

read

@GET
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
SecurityQuestionTO read(@NotNull @PathParam(value="key")
                                                                                                                               @NotNull String key)

Returns security question with matching key.

Parameters:

key - security question key to be read

Returns:

security question with matching key

create

@POST
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                                                                                                                                                                               @NotNull SecurityQuestionTO securityQuestionTO)

Creates a new security question.

Parameters:

securityQuestionTO - security question to be created

Returns:

Response object featuring Location header of created security question

update

@PUT
 @Path(value="{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void update(@NotNull
                                                                                                                                                                                               @NotNull SecurityQuestionTO securityQuestionTO)

Updates the security question matching the provided key.

Parameters:

securityQuestionTO - security question to be stored

delete

@DELETE
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam(value="key")
                                                                                                                      @NotNull String key)

Deletes the security question matching the provided key.

Parameters:

key - security question key to be deleted

readByUser

@GET
 @Path(value="byUser/{username}")
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
SecurityQuestionTO readByUser(@NotNull @PathParam(value="username")
                                                                                                                                                                                                                             @NotNull String username)

Ask for security question configured for the user matching the given username, if any.

Parameters:

username - username for which the security question is requested

Returns:

security question, if configured for the user matching the given username