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

Interface SAML2SP4UIIdPService

All Superinterfaces:
org.apache.syncope.common.rest.api.service.JAXRSService
@Path("saml2sp4ui/identityProviders") public interface SAML2SP4UIIdPService extends org.apache.syncope.common.rest.api.service.JAXRSService
REST operations for SAML 2.0 SP4UI Identity Providers.

  • 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
    void
    delete(String key)
    Deletes the SAML 2.0 Identity Provider with matching entityID.
    jakarta.ws.rs.core.Response
    importFromMetadata(@NotNull InputStream input)
    Imports the SAML 2.0 Identity Provider definitions available in the provided XML metadata.
    List<org.apache.syncope.common.lib.to.SAML2SP4UIIdPTO>
    list()
    Returns a list of all defined SAML 2.0 Identity Providers.
    org.apache.syncope.common.lib.to.SAML2SP4UIIdPTO
    read(String key)
    Returns the SAML 2.0 Identity Provider with matching entityID, if available.
    void
    update(@NotNull org.apache.syncope.common.lib.to.SAML2SP4UIIdPTO saml2IdpTO)
    Updates the SAML 2.0 Identity Provider with matching entityID.

  • Method Details

    • list

      @GET @Produces({"application/json","application/yaml","application/xml"}) List<org.apache.syncope.common.lib.to.SAML2SP4UIIdPTO> list()
      Returns a list of all defined SAML 2.0 Identity Providers.
      Returns:
      list of all defined SAML 2.0 Identity Providers

    • read

      @GET @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) org.apache.syncope.common.lib.to.SAML2SP4UIIdPTO read(@PathParam("key") String key)
      Returns the SAML 2.0 Identity Provider with matching entityID, if available.
      Parameters:
      key - SAML 2.0 Identity Provider's entityID
      Returns:
      SAML 2.0 Identity Provider with matching entityID, if available

    • importFromMetadata

      @POST @Consumes("application/xml") @Produces({"application/json","application/yaml","application/xml"}) jakarta.ws.rs.core.Response importFromMetadata(@NotNull @NotNull InputStream input)
      Imports the SAML 2.0 Identity Provider definitions available in the provided XML metadata.
      Parameters:
      input - XML metadata
      Returns:
      the entityID values for all imported SAML 2.0 Identity Providers

    • 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.SAML2SP4UIIdPTO saml2IdpTO)
      Updates the SAML 2.0 Identity Provider with matching entityID.
      Parameters:
      saml2IdpTO - idp configuration to be stored

    • delete

      @DELETE @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) void delete(@PathParam("key") String key)
      Deletes the SAML 2.0 Identity Provider with matching entityID.
      Parameters:
      key - SAML 2.0 Identity Provider's entityID