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

Interface ReconciliationService

All Superinterfaces:
JAXRSService
All Known Implementing Classes:
ReconciliationServiceImpl
@Path("reconciliation") public interface ReconciliationService extends JAXRSService
REST operations for reconciliation.

  • Method Details

    • status

      @GET @Produces({"application/json","application/yaml","application/xml"}) 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<ProvisioningReport> push(@BeanParam ReconQuery query, @NotNull @NotNull 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<ProvisioningReport> pull(@BeanParam ReconQuery query, @NotNull @NotNull 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") Response push(@BeanParam 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<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