Package io.jans.configapi.plugin.scim.rest

Class ScimConfigResource

java.lang.Object

io.jans.configapi.core.rest.BaseResource

io.jans.configapi.plugin.scim.rest.ScimConfigResource

@Path("/scim-config")
@Produces("application/json")
@Consumes("application/json")
public class ScimConfigResource
extends io.jans.configapi.core.rest.BaseResource

Constructor Summary

Constructors

Constructor	Description
ScimConfigResource()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getAppConfiguration()	Retrieve the current SCIM application configuration.
jakarta.ws.rs.core.Response	patchAppConfigurationProperty(@NotNull String requestString)	Apply a JSON Patch to the SCIM App configuration and persist the change.

Methods inherited from class io.jans.configapi.core.rest.BaseResource

checkNotEmpty, checkNotEmpty, checkNotNull, checkNotNull, checkNotNull, checkResourceNotNull, createSearchRequest, findRootError, getBadRequestException, getBadRequestException, getBadRequestException, getHttpHeaders, getHttpRequest, getInternalServerException, getInternalServerException, getMissingAttributeError, getNotAcceptableException, getNotFoundError, getNotFoundError, getUriInfo, throwBadRequestException, throwBadRequestException, throwBadRequestException, throwInternalServerException, throwInternalServerException, throwInternalServerException, throwInternalServerException, throwMissingAttributeError, throwNotFoundException, throwNotFoundException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScimConfigResource

public ScimConfigResource()

Method Detail

getAppConfiguration

@GET
public jakarta.ws.rs.core.Response getAppConfiguration()

Retrieve the current SCIM application configuration.

Returns:

a Response with the current AppConfiguration serialized as JSON (HTTP 200 on success)

patchAppConfigurationProperty

@PATCH
@Consumes("application/json-patch+json")
public jakarta.ws.rs.core.Response patchAppConfigurationProperty(@NotNull
                                                                 @NotNull String requestString)
                                                          throws IOException,
                                                                 com.github.fge.jsonpatch.JsonPatchException

Apply a JSON Patch to the SCIM App configuration and persist the change.

Parameters:

requestString - JSON Patch document (array of patch operations) as a string.

Returns:

the updated AppConfiguration after the patch is applied.

Throws:

IOException - if reading or writing the stored configuration fails.

com.github.fge.jsonpatch.JsonPatchException - if the provided patch document cannot be applied.