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

Interface SecurityQuestionService

All Superinterfaces:
JAXRSService
All Known Implementing Classes:
SecurityQuestionServiceImpl
@Path("securityQuestions") public interface SecurityQuestionService extends JAXRSService
REST operations for security questions.

  • Method Details

    • list

      @GET @Produces({"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("{key}") @Produces({"application/json","application/yaml","application/xml"}) SecurityQuestionTO read(@NotNull @PathParam("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({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) 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("{key}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"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("{key}") @Produces({"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam("key") @NotNull String key)
      Deletes the security question matching the provided key.
      Parameters:
      key - security question key to be deleted

    • readByUser

      @GET @Path("byUser/{username}") @Produces({"application/json","application/yaml","application/xml"}) @Consumes({"application/json","application/yaml","application/xml"}) SecurityQuestionTO readByUser(@NotNull @PathParam("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