Apache Directory SCIMple

Jakarta EE implementation of the Simple Cross-domain Identity Management (SCIM) version 2.0 specification as defined by the following RFCs:

• RFC7643 - SCIM: Core Schema

• RFC7644 - SCIM: Protocol

• RFC7642 - SCIM: Definitions, Overview, Concepts, and Requirements

Project

Please fork this project and contribute Pull-Requests via this project's Github page. Issue tracking is being transitioned to the Apache Foundation's Jira server.

Please visit our project page at https://directory.apache.org/scimple.

Features

• A full-featured Java SCIM client
• Declarative creation of new ResourceTypes and Extensions
• Dynamic generation of the Schema and ResourceType end-points.
• A suite of tools to allow the creation of SCIM resources that can then be verified against the appropriate schemas.

Future features

• Example implementations of the server with various persistence paradigms.
• A set of verification tests to ensure the project meets the specification and to allow inter-operability testing.

Example code

Examples of the project's declarative syntax are shown below. The first example shows how a SCIM resource is declared:

@Data
@EqualsAndHashCode(callSuper = true)
@ScimResourceType(
    id = ScimUser.RESOURCE_NAME,
    name = ScimUser.RESOURCE_NAME,
    schema = ScimUser.SCHEMA_URI,
    description = "Top level ScimUser",
    endpoint = "/Users"
)
@XmlRootElement(name = ScimUser.RESOURCE_NAME)
@XmlAccessorType(XmlAccessType.FIELD)
public class ScimUser extends ScimResource {

    public static final String RESOURCE_NAME = "User";
    public static final String SCHEMA_URI = "urn:ietf:params:scim:schemas:core:2.0:User";

    @ScimAttribute(
    description="A Boolean value indicating the User's administrative status.",
    type=Type.BOOLEAN
    )
    
    @XmlElement(name = "active")
    Boolean active = true;

    @ScimAttribute(
    type = Type.COMPLEX,
    description="A physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes."
    )
    @XmlElement(name = "addresses")
    List<Address> addresses;

In the example above, annotations are used at the class level and member level to declare a new SCIM resource and its attributes respectively. The example below shows the equivalent declaration for a resource Extension:

@XmlRootElement
@XmlAccessorType(XmlAccessType.NONE)
@ScimExtensionType(
    required = false,
    name = "EnterpriseUser",
    id = EnterpriseExtension.URN,
    description = "Attributes commonly used in representing users that belong to, or act on behalf of, a business or enterprise."
)
@Data
public class EnterpriseExtension implements ScimExtension {

    public static final String URN = "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User";

    @XmlType
    @XmlAccessorType(XmlAccessType.NONE)
    @Data
    @Accessors(chain = true)
    public static class Manager {

        @ScimAttribute(
        description = "The \"id\" of the SCIM resource representing the user's manager.  RECOMMENDED."
        )
    
        @XmlElement
        private String value;

        @ScimAttribute(
        description = "The URI of the SCIM resource representing the User's manager.  RECOMMENDED."
        )
        
        @XmlElement
        private String $ref;

This example shows how an extension is declared at the class level, but also provides an example of how complex SCIM types can be simply defined as suitably annotated inner classes.

Implementations are fully customizable without altering the core server code. The example below shows how the implementation for a repository is declared:

public class InMemoryUserService implements Respository<ScimUser> {

Implementing the repository interface allows the customization of create, retrieve, update, and delete methods (as well as find). Customization is flexible - if your system implements soft deletes, create a delete method that simply sets a flag and alter the find and retrieve methods to only return "undeleted" resources.

Requests to Repository Mappings

At a high level SCIMple provides the marshaling and unmarshaling of SCIM requests and responses to and from the appropriate repository methods and supporting endpoints (e.g. /Schema, /ServiceProvider, and /ResourceTypes). The following table shows the mapping of SCIM requests to repository methods:

SCIM Endpoint	HTTP Method	Repository Method
Users
/Users	GET	repository.find()
/Users	POST	repository.create()
/Users/{id}	GET	repository.get()
/Users/{id}	PUT	repository.update()
/Users/{id}	PATCH	repository.patch()
/Users/{id}	DELETE	repository.delete()
Groups
/Groups	GET	repository.find()
/Groups	POST	repository.create()
/Groups/{id}	GET	repository.get()
/Groups/{id}	PUT	repository.update()
/Groups/{id}	PATCH	repository.patch()
/Groups/{id}	DELETE	repository.delete()
Other
/Bulk	POST	repository.*

NOTE: The /Bulk endpoint enables clients to send a potentially large collection of resource operations in a single request, replacing the need to send multiple requests.

Building & Contributing

Clone the code and build it!

Prerequisites

• Java 17+

NOTE: The build runs with Java 17+, but compiles to Java 11.

git clone https://github.com/apache/directory-scimple.git
cd directory-scimple
./mvnw package
# or on windows
# mvnw.bat package

Project modules

Name	Description
scim-spec/scim-spec-schema	SCIM relate models from RFC7643 and Filter related models from RFC7644
scim-spec/scim-spec-protocol	All other REST related models from RFC7644
scim-client	A SCIM REST Client
scim-core	SCIMple Repository related classes, used to provide CRUD operations to a data store (e.g. a database), see above example
scim-server	REST Endpoint implementations
scim-server-examples	Various server examples
scim-compliance-tests	Integration tests that can be used to test a SCIM server