Repository navigation
We have just released version 6.1.0 of the UnboundID SCIM 2 SDK. It is available for download from GitHub and the Maven Central Repository. This release includes the following changes:
-
Deprecated the following parameters. They will be removed in a future release. If you do not modify these, there is no change to make.
-
BulkResourceMapper.java: Renamed toScimResourceMapper.javafor use in non-bulk workflows. The BulkResourceMapper class will be removed in a future release. -
BaseScimResource.IGNORE_UNKNOWN_FIELDS: This system property modifies behavior when a JSON string is transformed into a Java object. If the JSON value contains extra fields that cannot be stored on the object, then an exception will be thrown unless this property istrue(the current default as of 6.0.0). However, as we've stated elsewhere, adding fields to an API response is not considered a breaking change by convention. The SCIM standard has done this several times recently, such as addingnextCursorto aListResponsein RFC 9865. In other words, a client written with an old release of the SCIM SDK could have problems parsing valid SCIM responses from the future if this property isfalse. To avoid brittle behavior, it is imperative that unknown JSON fields are always ignored. Thus, this property will be removed for better interoperability. -
DateTimeUtils.USE_GMT_CALENDARS: DateTimeUtils initially used JAX-B for date-time processing, mostly for Java 7 support. JAX-B's Calendar objects always used a "GMT+00:00" timezone by default, but Calendar objects in Java are much more likely to use UTC instead. Furthermore, UTC was designed for date-time synchronization, so it is a better timezone to use for the default region. JAX-B was removed in 5.0.0, but GMT support was kept with a system property for legacy uses. For consistency, we intend to remove this property, as UTC has been in use by default since 6.0.0.
-
-
Added support for RFC 9944, an update to the SCIM standard describing device management with SCIM. For an overview on leveraging device management with the SCIM SDK, see the DeviceResource class-level Javadoc. This update includes:
- A new
com.unboundid.scim2.common.types.devicespackage that contains model classes for resources such asEndpointAppResource, as well as extension objects such asBleDeviceExtension. AttributeDefinition.javahas been updated with new fields such aspattern, as well as the addition ofMANUFACTURERandENTERPRISEuniqueness constants.
- A new
-
(#311) Fixed an issue with deserializing GenericScimResource objects embedded within a list response.
-
(#309) Updated
AttributeDefinition.javato use default values for missing definitions as dictated by RFC 7643. For example, ifuniquenessis missing from a JSON object, the AttributeDefinition will useUniqueness.NONE. This class's documentation was also updated to provide better details. -
(#224) Added support for applying patch operations that a) do not contain a
path, and b) also include nested paths within itsvalue. These are not defined by the standard, but are still used by some SCIM provisioning engines. For example:{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "add", "value": { "name.givenName": "Melody" } } ] } -
Added a maximum array size threshold for the target of a patch operation. Now, PATCH updates that would result in over 25,000 elements within an array will throw a
BadRequestException. This value is controlled by thecom.unboundid.scim2.common.utils.JsonUtils.maxPatchArraySizeproperty. -
Updated bulk patch operations to reflect RFC 7644's errata and include the "schemas" field, representing a full PatchRequest. When the SCIM SDK converts a bulk patch JSON into a Java object, it is permissive and will add the
schemasfield if it was missing from the source.// Previously: { "method": "PATCH", "path": "/Users/5d8d29d3-342c-4b5f-8683-a3cb6763ffcc", "data": { "Operations": [] } } // Now: { "method": "PATCH", "path": "/Users/5d8d29d3-342c-4b5f-8683-a3cb6763ffcc", "data": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [] } }
-
Updated
DateTimeUtils.parse()to support date strings without timestamps (e.g., "1970-01-01"). The time values will always be set to the start of the day. -
Added a new
Path.stream()method, allowing access to elements of a path with the Java Stream API.
Other minor fixes/updates include:
-
Fixed an issue where GenericScimResource would use case-sensitive property names if the resource was initialized with an ObjectNode that was not a SCIM SDK
CaseIgnoreObjectNode. -
Corrected an annotation in
PatchRequestwhich did not markOperationswith a multiValueClass. -
Fixed an issue where Jackson
JsonReadFeatureproperties were not used despite the property being set on the MapperFactory. -
Updated
AttributeDefinition.toString()to print a JSON model of the object to be consistent with all other SCIM objects in the library. -
Updated the
@Attributeannotation of all$reffields to label them as not required for consistency across groups, devices, and other model classes. -
Updated Jackson from 3.1.3 to 3.2.3 and jackson-annotations from 2.21 to 2.22.