SCIM SDK (System for Cross-domain Identity Management)

The server implementation is highly generic, allowing you to define custom schema representations for resources. You can even override default core schemata like User or Group (e.g., to exclude attributes like ims or phoneNumbers).

To define a resource, you need two JSON documents:

1. A schema definition: Describes the resource you want to supply.
2. A resource type definition: Describes the endpoint and any additional schema extensions used within the schema definition.

The SCIM SDK provides API libraries for REST methods but does not include the implementations as transitive dependencies. You must provide the corresponding JAX-RS API dependencies in your project to use the built-in REST API methods.

<dependency>
    <groupId>javax.ws.rs</groupId>
    <artifactId>javax.ws.rs-api</artifactId>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>jakarta.ws.rs</groupId>
    <artifactId>jakarta.ws.rs-api</artifactId>
    <optional>true</optional>
</dependency>

To deploy the SCIM Spring Boot sample project, build the JAR archive using Maven and then execute the resulting JAR file with the Java runtime. Once running, the SCIM endpoints will be accessible at the specified local URLs.

# Build the project
mvn clean package

# Run the application
java -jar scim-sdk-springboot-example-${project.version}.jar

The scim-sdk-schema-pojo-creator is a Spring Shell application used to generate Java POJO objects from SCIM schema files.

To use it:

1. Ensure you have JDK 8 or higher installed.
2. Download the JAR artifact from the SCIM-SDK releases section.
3. Run the JAR directly from a terminal (PowerShell, Linux shell, etc.) using the following command:

java -jar scim-sdk-schema-pojo-creator-${version}.jar

To deploy the SCIM example in a JBoss/WildFly environment, build the WAR archive using Maven and move the resulting file to your JBoss deployments directory.

1. Build the project: mvn clean package
2. Locate the generated file: scim-sdk-jboss-example-${project.version}.war.
3. Copy this file into the deployments directory of your JBoss instance.

This sample has been tested with WildFly 19.1.0 and WildFly 22.0.0.

When constructing a Bulk request, the following constraints are enforced by the BulkEndpoint:

• Allowed HTTP Methods: Typically POST, PUT, PATCH, and DELETE. GET is only allowed if the service provider explicitly supports bulk GET.
• POST Requirement: Every POST operation within a bulk request must include a bulkId to allow for subsequent referencing.
• Payload Size: The request body must not exceed the maxPayloadSize defined in the BulkConfig.
• Operation Count: The number of operations in the request must not exceed maxOperations defined in the BulkConfig.
• Duplicate IDs: Each bulkId in the request must be unique.

If the translate command runs but expected resources are not generated, ensure the following rules are met:

1. Resource Type Presence: ResourceHandler and EndpointDefinition implementations are only created if a corresponding resource-type JSON definition exists.
2. Schema Validation: Schemas are validated against meta-schema representations; invalid schemas will be skipped.
3. File Extensions: Both resource-schema and resource-type filenames must end with .json.
4. Reference Integrity: If a resource-type file contains a reference in its schema attribute to a resource-schema that cannot be found, the entire resource will be ignored because the underlying resource base is missing.

Once the application shell is open, use the translate command to process SCIM schemas into Java POJOs. This command gathers resource-schema and resource-type files, validates their relations, and writes the generated classes to your specified output directory.

Command Syntax

translate [--location String] --recursive boolean --output String --package String --useLombok boolean --override boolean --create-config boolean

translate -r -l /path/to/scim/resources -o /path/to/src/main/java -p com.example.scim --useLombok --create-config

The behavior of the BulkEndpoint is governed by the BulkConfig object provided by the ServiceProvider. Developers implementing a ServiceProvider should configure these keys to control server load and behavior:

• supported: Boolean indicating if bulk operations are enabled.
• maxOperations: The maximum number of operations allowed in a single bulk request.
• maxPayloadSize: The maximum allowed size (in bytes) for the bulk request body.
• supportBulkGet: Boolean indicating if GET operations are permitted in bulk requests.
• returnResourcesEnabled: Global toggle for whether resource bodies are returned in responses.
• returnResourcesByDefault: If returnResourcesEnabled is true, this determines if resources are returned even if the client doesn't explicitly ask for them.