Package org.apache.directory.scim.protocol

Interface SchemaResource

All Known Implementing Classes:
SchemaResourceImpl
@Path("Schemas") public interface SchemaResource
From SCIM Protocol Specification, section 4, page 74
See Also:
  • Scim spec section 4 /Schemas An HTTP GET to this endpoint is used to retrieve information about resource schemas supported by a SCIM service provider. An HTTP GET to the endpoint "/Schemas" SHALL return all supported schemas in ListResponse format (see Figure 3). Individual schema definitions can be returned by appending the schema URI to the /Schemas endpoint. For example: /Schemas/urn:ietf:params:scim:schemas:core:2.0:User The contents of each schema returned are described in Section 7 of [RFC7643]. An example representation of SCIM schemas may be found in Section 8.7 of [RFC7643]. In cases where a request is for a specific "ResourceType" or "Schema", the single JSON object is returned in the same way that a single User or Group is retrieved, as per Section 3.4.1. When returning multiple ResourceTypes or Schemas, the message form described by the "urn:ietf:params:scim:api:messages:2.0:ListResponse" (ListResponse) form SHALL be used as shown in Figure 3 and in Figure 9 below. Query parameters described in Section 3.4.2, such as filtering, sorting, and pagination, SHALL be ignored. If a "filter" is provided, the service provider SHOULD respond with HTTP status code 403 (Forbidden) to ensure that clients cannot incorrectly assume that any matching conditions specified in a filter are true.

  • Method Summary

    Modifier and Type
    Method
    Description
    default jakarta.ws.rs.core.Response
    getAllSchemas(String filter, jakarta.ws.rs.core.UriInfo uriInfo)
     
    default jakarta.ws.rs.core.Response
    getSchema(String uri, jakarta.ws.rs.core.UriInfo uriInfo)
     

  • Method Details

    • getAllSchemas

      @GET @Produces({"application/scim+json","application/json"}) default jakarta.ws.rs.core.Response getAllSchemas(@QueryParam("filter") String filter, @Context jakarta.ws.rs.core.UriInfo uriInfo)

    • getSchema

      @GET @Path("{uri}") @Produces({"application/scim+json","application/json"}) default jakarta.ws.rs.core.Response getSchema(@PathParam("uri") String uri, @Context jakarta.ws.rs.core.UriInfo uriInfo)