Interface PasswordManagementService

All Superinterfaces:
org.apache.syncope.common.rest.api.service.JAXRSService
@Path("passwordManagement") public interface PasswordManagementService extends org.apache.syncope.common.rest.api.service.JAXRSService
REST operations for password management modules.

  • 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_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    create(@NotNull org.apache.syncope.common.lib.to.PasswordManagementTO passwordManagementTO)
    Create a new password management module.
    void
    delete(@NotNull String key)
    Delete password management module matching the given key.
    List<org.apache.syncope.common.lib.to.PasswordManagementTO>
    list()
    Returns a list of password management modules.
    org.apache.syncope.common.lib.to.PasswordManagementTO
    read(@NotNull String key)
    Returns the password management module matching the given key.
    void
    update(@NotNull org.apache.syncope.common.lib.to.PasswordManagementTO passwordManagementTO)
    Updates password management module matching the given key.

  • Method Details

    • read

      @GET @Path("{key}") @Produces("application/json") org.apache.syncope.common.lib.to.PasswordManagementTO read(@NotNull @PathParam("key") @NotNull String key)
      Returns the password management module matching the given key.
      Parameters:
      key - key of requested password management module
      Returns:
      password management module with matching id

    • list

      @GET @Produces("application/json") List<org.apache.syncope.common.lib.to.PasswordManagementTO> list()
      Returns a list of password management modules.
      Returns:
      list of password management modules

    • create

      @POST @Consumes("application/json") @Produces("application/json") jakarta.ws.rs.core.Response create(@NotNull @NotNull org.apache.syncope.common.lib.to.PasswordManagementTO passwordManagementTO)
      Create a new password management module.
      Parameters:
      passwordManagementTO - PasswordManagement to be created.
      Returns:
      Response object featuring Location header of created password management module

    • update

      @PUT @Path("{key}") @Consumes("application/json") @Produces("application/json") void update(@NotNull @NotNull org.apache.syncope.common.lib.to.PasswordManagementTO passwordManagementTO)
      Updates password management module matching the given key.
      Parameters:
      passwordManagementTO - PasswordManagement to replace existing password management module

    • delete

      @DELETE @Path("{key}") @Produces("application/json") void delete(@NotNull @PathParam("key") @NotNull String key)
      Delete password management module matching the given key.
      Parameters:
      key - key of password management module to be deleted