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

Interface ReconciliationService

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

  • 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
    List<org.apache.syncope.common.lib.to.ProvisioningReport>
    pull(CSVPullSpec spec, InputStream csv)
    Pulls the CSV input into Syncope according to the provided specification.
    List<org.apache.syncope.common.lib.to.ProvisioningReport>
    pull(ReconQuery query, @NotNull org.apache.syncope.common.lib.to.PullTaskTO pullTask)
    Pulls the matching user, group, any object or linked account from the External Resource into Syncope.
    jakarta.ws.rs.core.Response
    push(org.apache.syncope.common.rest.api.beans.AnyQuery anyQuery, CSVPushSpec spec)
    Export a list of any objects matching the given query as CSV according to the provided specification.
    List<org.apache.syncope.common.lib.to.ProvisioningReport>
    push(ReconQuery query, @NotNull org.apache.syncope.common.lib.to.PushTaskTO pushTask)
    Pushes the matching user, group, any object or linked account in Syncope onto the External Resource.
    org.apache.syncope.common.lib.to.ReconStatus
    status(ReconQuery query)
    Gets compared status between attributes in Syncope and on the given External Resource.

  • Method Details

    • status

      @GET @Produces({"application/json","application/yaml","application/xml"}) org.apache.syncope.common.lib.to.ReconStatus status(@BeanParam ReconQuery query)
      Gets compared status between attributes in Syncope and on the given External Resource.
      Parameters:
      query - query conditions
      Returns:
      reconciliation status

    • push

      @POST @Path("push") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) List<org.apache.syncope.common.lib.to.ProvisioningReport> push(@BeanParam ReconQuery query, @NotNull @NotNull org.apache.syncope.common.lib.to.PushTaskTO pushTask)
      Pushes the matching user, group, any object or linked account in Syncope onto the External Resource.
      Parameters:
      query - query conditions
      pushTask - push specification
      Returns:
      push report

    • pull

      @POST @Path("pull") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) List<org.apache.syncope.common.lib.to.ProvisioningReport> pull(@BeanParam ReconQuery query, @NotNull @NotNull org.apache.syncope.common.lib.to.PullTaskTO pullTask)
      Pulls the matching user, group, any object or linked account from the External Resource into Syncope.
      Parameters:
      query - query conditions
      pullTask - pull specification
      Returns:
      pull report

    • push

      @GET @Path("csv/push") @Consumes({"application/json","application/yaml","application/xml"}) @Produces("text/csv") jakarta.ws.rs.core.Response push(@BeanParam org.apache.syncope.common.rest.api.beans.AnyQuery anyQuery, @BeanParam CSVPushSpec spec)
      Export a list of any objects matching the given query as CSV according to the provided specification.
      Parameters:
      anyQuery - query conditions
      spec - CSV push specification
      Returns:
      CSV content matching the provided specification

    • pull

      @POST @Path("csv/pull") @Consumes("text/csv") @Produces({"application/json","application/yaml","application/xml"}) List<org.apache.syncope.common.lib.to.ProvisioningReport> pull(@BeanParam CSVPullSpec spec, InputStream csv)
      Pulls the CSV input into Syncope according to the provided specification.
      Parameters:
      spec - CSV pull specification
      csv - CSV input
      Returns:
      pull report