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

Interface RemediationService

All Superinterfaces:
org.apache.syncope.common.rest.api.service.JAXRSService
@Path("remediations") public interface RemediationService extends org.apache.syncope.common.rest.api.service.JAXRSService
REST operations for remediations.

  • 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
    delete(@NotNull String key)
    Deletes the remediation matching the given key.
    org.apache.syncope.common.lib.to.PagedResult<org.apache.syncope.common.lib.to.RemediationTO>
    list(org.apache.syncope.common.rest.api.beans.RemediationQuery query)
    Returns a list of all remediations.
    org.apache.syncope.common.lib.to.RemediationTO
    read(@NotNull String key)
    Returns remediation with matching key.
    jakarta.ws.rs.core.Response
    remedy(@NotNull String remediationKey, @NotNull String anyKey)
    Perform remediation by deleting the provided user, group or any object.
    jakarta.ws.rs.core.Response
    remedy(@NotNull String remediationKey, @NotNull org.apache.syncope.common.lib.request.AnyCR createReq)
    Perform remediation by creating the provided user, group or any object.
    jakarta.ws.rs.core.Response
    remedy(@NotNull String remediationKey, @NotNull org.apache.syncope.common.lib.request.AnyUR updateReq)
    Perform remediation by updating the provided user, group or any object.

  • Method Details

    • list

      @GET @Produces({"application/json","application/yaml","application/xml"}) org.apache.syncope.common.lib.to.PagedResult<org.apache.syncope.common.lib.to.RemediationTO> list(@BeanParam org.apache.syncope.common.rest.api.beans.RemediationQuery query)
      Returns a list of all remediations.
      Parameters:
      query - query conditions
      Returns:
      list of all remediations.

    • read

      @GET @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) org.apache.syncope.common.lib.to.RemediationTO read(@NotNull @PathParam("key") @NotNull String key)
      Returns remediation with matching key.
      Parameters:
      key - key of remediation to be read
      Returns:
      remediation with matching key

    • delete

      @DELETE @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) jakarta.ws.rs.core.Response delete(@NotNull @PathParam("key") @NotNull String key)
      Deletes the remediation matching the given key.
      Parameters:
      key - key for remediation to be deleted
      Returns:
      an empty response if operation was successful

    • remedy

      @POST @Path("{remediationKey}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) jakarta.ws.rs.core.Response remedy(@NotNull @PathParam("remediationKey") @NotNull String remediationKey, @NotNull @NotNull org.apache.syncope.common.lib.request.AnyCR createReq)
      Perform remediation by creating the provided user, group or any object.
      Parameters:
      remediationKey - key for remediation to act on
      createReq - user, group or any object to create
      Returns:
      Response object featuring Location header of created object as well as the object itself enriched with propagation status information

    • remedy

      @PATCH @Path("{remediationKey}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) jakarta.ws.rs.core.Response remedy(@NotNull @PathParam("remediationKey") @NotNull String remediationKey, @NotNull @NotNull org.apache.syncope.common.lib.request.AnyUR updateReq)
      Perform remediation by updating the provided user, group or any object.
      Parameters:
      remediationKey - key for remediation to act on
      updateReq - user, group or any object to update
      Returns:
      Response object featuring the updated object enriched with propagation status information

    • remedy

      @DELETE @Path("{remediationKey}/{anyKey}") @Produces({"application/json","application/yaml","application/xml"}) jakarta.ws.rs.core.Response remedy(@NotNull @PathParam("remediationKey") @NotNull String remediationKey, @NotNull @PathParam("anyKey") @NotNull String anyKey)
      Perform remediation by deleting the provided user, group or any object.
      Parameters:
      remediationKey - key for remediation to act on
      anyKey - user's, group's or any object's key to delete
      Returns:
      Response object featuring the deleted object enriched with propagation status information