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

Interface AuthProfileService

All Superinterfaces:
org.apache.syncope.common.rest.api.service.JAXRSService
@Path("authProfiles") public interface AuthProfileService extends org.apache.syncope.common.rest.api.service.JAXRSService
REST operations for Auth profiles.

  • 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.AuthProfileTO authProfileTO)
    Create a new auth profile.
    void
    delete(@NotNull String key)
    Deletes the auth profile matching the provided if key, if found.
    org.apache.syncope.common.lib.to.PagedResult<org.apache.syncope.common.lib.to.AuthProfileTO>
    list(@jakarta.validation.constraints.Min(1L) int page, @jakarta.validation.constraints.Min(1L) int size)
    Returns the paginated list of existing auth profiles.
    org.apache.syncope.common.lib.to.AuthProfileTO
    read(@NotNull String key)
    Returns the auth profile matching the provided if key, if found.
    void
    update(@NotNull org.apache.syncope.common.lib.to.AuthProfileTO authProfileTO)
    Updates the auth profile matching the provided if key, if found.

  • Method Details

    • list

      @GET @Produces({"application/json","application/yaml","application/xml"}) org.apache.syncope.common.lib.to.PagedResult<org.apache.syncope.common.lib.to.AuthProfileTO> list(@Min(1L) @QueryParam("page") @DefaultValue("1") @jakarta.validation.constraints.Min(1L) int page, @Min(1L) @QueryParam("size") @DefaultValue("25") @jakarta.validation.constraints.Min(1L) int size)
      Returns the paginated list of existing auth profiles.
      Parameters:
      page - search page
      size - search page size
      Returns:
      the paginated list of existing auth profiles

    • read

      @GET @Path("{key}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) org.apache.syncope.common.lib.to.AuthProfileTO read(@NotNull @PathParam("key") @NotNull String key)
      Returns the auth profile matching the provided if key, if found.
      Parameters:
      key - auth profile key
      Returns:
      auth profile matching the provided if key, if found

    • create

      @POST @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) jakarta.ws.rs.core.Response create(@NotNull @NotNull org.apache.syncope.common.lib.to.AuthProfileTO authProfileTO)
      Create a new auth profile.
      Parameters:
      authProfileTO - auth profile to create
      Returns:
      Response object featuring Location header of created client app

    • update

      @PUT @Path("{key}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) void update(@NotNull @NotNull org.apache.syncope.common.lib.to.AuthProfileTO authProfileTO)
      Updates the auth profile matching the provided if key, if found.
      Parameters:
      authProfileTO - auth profile

    • delete

      @DELETE @Path("{key}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam("key") @NotNull String key)
      Deletes the auth profile matching the provided if key, if found.
      Parameters:
      key - auth profile key