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

Interface SAML2IdPEntityService

All Superinterfaces:
org.apache.syncope.common.rest.api.service.JAXRSService
@Path("saml2/idp") public interface SAML2IdPEntityService extends org.apache.syncope.common.rest.api.service.JAXRSService
REST operations for SAML 2.0 IdP metadata.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_OWNER
     

    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
    void
    delete(@NotNull String key)
    Deletes the SAML 2.0 IdP entity matching the given key.
    org.apache.syncope.common.lib.to.SAML2IdPEntityTO
    get(@NotNull String key)
    Returns the SAML 2.0 IdP entity matching the given key.
    List<org.apache.syncope.common.lib.to.SAML2IdPEntityTO>
    list()
    Returns the SAML 2.0 IdP entities.
    void
    set(@NotNull org.apache.syncope.common.lib.to.SAML2IdPEntityTO entityTO)
    Stores the entity to finalize the generation process.

  • Field Details

  • Method Details

    • list

      @GET @Produces({"application/json","application/yaml","application/xml"}) List<org.apache.syncope.common.lib.to.SAML2IdPEntityTO> list()
      Returns the SAML 2.0 IdP entities.
      Returns:
      SAML 2.0 IdP entities

    • get

      @GET @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) org.apache.syncope.common.lib.to.SAML2IdPEntityTO get(@NotNull @PathParam("key") @NotNull String key)
      Returns the SAML 2.0 IdP entity matching the given key.
      Parameters:
      key - key of requested SAML 2.0 IdP entity
      Returns:
      SAML 2.0 IdP entity with matching key

    • set

      @POST @Path("{key}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) void set(@NotNull @NotNull org.apache.syncope.common.lib.to.SAML2IdPEntityTO entityTO)
      Stores the entity to finalize the generation process.
      Parameters:
      entityTO - entity to be created

    • delete

      @DELETE @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam("key") @NotNull String key)
      Deletes the SAML 2.0 IdP entity matching the given key.
      Parameters:
      key - key of requested SAML 2.0 IdP entity