Home

UnboundID SCIM 2 SDK for Java

SCIM 2.0 is an IETF standard that defines an extensible schema mechanism and REST API for managing users or other types of data. The UnboundID SCIM 2 SDK provides a simple yet powerful API for developing SCIM 2 applications and servers with Java or other JVM languages.

Why use the UnboundID SCIM 2 SDK?

The SCIM 2 protocol is a resource-based HTTP API, and is therefore reasonably technology-agnostic; it should be possible to interoperate with a SCIM 2 service provider using any programming language or HTTP toolkit. If you're a Java developer, however, the SCIM 2 SDK provides some compelling benefits. For example, it:

• Handles the details of making SCIM requests with a fluent requests API, including SCIM's sometimes intricate PATCH format.
• Accommodates varying styles for working with the SCIM resources that are returned by SCIM service providers.
• Provides useful utility methods for selecting data from JSON objects.

Documentation

A SCIM client developer will be concerned with three topics: requests, responses, and attribute paths. These are discussed in the following articles:

• Making SCIM requests
• Working with SCIM resources
• Working with SCIM Paths

This wiki is intended as a complement to the SCIM 2 SDK Javadocs.

• scim2-sdk-client
• scim2-ubid-extensions
• scim2-sdk-server
• scim2-sdk-common

If you are unfamiliar with SCIM 2.0, you are encouraged to refer to the specifications. They're easy reads.

• RFC 7643, SCIM 2.0 Core Schema
• RFC 7644, SCIM 2.0 Protocol

Prerequisites

The SCIM 2 SDK requires Java 6 or greater.

Downloads

The SCIM 2 SDK is available as a component in Maven Central.

If you are writing a SCIM 2 client, use the scim2-sdk-client component. This will include the scim2-sdk-common component as a transitive dependency.

<dependency>
  <groupId>com.unboundid.product.scim2</groupId>
  <artifactId>scim2-sdk-client</artifactId>
  <version>1.1.35</version>
</dependency>

If you are writing a SCIM 2 client for UnboundID servers, use the scim2-ubid-extensions component. This will include the scim2-sdk-client and scim2-sdk-common components as transitive dependencies.

<dependency>
  <groupId>com.unboundid.product.scim2</groupId>
  <artifactId>scim2-ubid-extensions</artifactId>
  <version>1.1.35</version>
</dependency>

You may also download SCIM 2 SDK builds from the Releases page.

License

The SCIM 2 SDK is LGPL-licensed. See the LICENSE file for more info.