Interface OIDCC4UIProviderService

    • Method Detail

      • list

        @GET
        @Produces({"application/json","application/yaml","application/xml"})
        List<OIDCC4UIProviderTO> list()
        Returns a list of all defined OIDC Providers.
        Returns:
        list of all defined OIDC Providers
      • read

        @GET
        @Path("{key}")
        @Produces({"application/json","application/yaml","application/xml"})
        OIDCC4UIProviderTO read​(@PathParam("key")
                                String key)
        Returns the OIDC Provider with matching key, if available.
        Parameters:
        key - OIDC Provider's key
        Returns:
        OIDC Providers with matching key, if available
      • create

        @POST
        @Consumes({"application/json","application/yaml","application/xml"})
        @Produces({"application/json","application/yaml","application/xml"})
        javax.ws.rs.core.Response create​(OIDCC4UIProviderTO oidcProviderTO)
        Creates a new OIDC Provider.
        Parameters:
        oidcProviderTO - OpenID Connect Provider configuration to be stored
        Returns:
        Response object featuring Location header of created OIDC Provider
      • createFromDiscovery

        @POST
        @Path("fromDiscovery")
        @Consumes({"application/json","application/yaml","application/xml"})
        @Produces({"application/json","application/yaml","application/xml"})
        javax.ws.rs.core.Response createFromDiscovery​(OIDCC4UIProviderTO oidcProviderTO)
        Creates a new OIDC Provider by using its Discovery Document.
        Parameters:
        oidcProviderTO - OpenID Connect Provider configuration to be stored
        Returns:
        Response object featuring Location header of created OIDC Provider
      • update

        @PUT
        @Path("{key}")
        @Consumes({"application/json","application/yaml","application/xml"})
        @Produces({"application/json","application/yaml","application/xml"})
        void update​(@NotNull
                    @NotNull OIDCC4UIProviderTO oidcProviderTO)
        Updates the OIDC Provider with matching key.
        Parameters:
        oidcProviderTO - OpenID Connect Provider configuration to be stored
      • delete

        @DELETE
        @Path("{key}")
        @Produces({"application/json","application/yaml","application/xml"})
        void delete​(@PathParam("key")
                    String key)
        Deletes the OIDC Provider with matching key.
        Parameters:
        key - OIDC Provider key