Package org.apache.directory.scim.protocol

Interface ResourceTypesResource

All Known Implementing Classes:
ResourceTypesResourceImpl
@Path("ResourceTypes") public interface ResourceTypesResource
From SCIM Protocol Specification, section 4, page 74
See Also:
  • Scim spec section 4 /ResourceTypes An HTTP GET to this endpoint is used to discover the types of resources available on a SCIM service provider (e.g., Users and Groups). Each resource type defines the endpoints, the core schema URI that defines the resource, and any supported schema extensions. The attributes defining a resource type can be found in Section 6 of [RFC7643], and an example representation can be found in Section 8.6 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
    getAllResourceTypes(String filter)
     
    default jakarta.ws.rs.core.Response
    getResourceType(String name)
     

  • Method Details

    • getAllResourceTypes

      @GET @Produces({"application/scim+json","application/json"}) default jakarta.ws.rs.core.Response getAllResourceTypes(@QueryParam("filter") String filter) throws Exception
      Throws:
      Exception

    • getResourceType

      @GET @Path("{name}") @Produces({"application/scim+json","application/json"}) default jakarta.ws.rs.core.Response getResourceType(@PathParam("name") String name) throws Exception
      Throws:
      Exception