Table of Contents

← Modules - SMS [sms] 
 Conventions →

Modules - SCIM [scim] - System for Cross-domain Identity Management

The System for Cross-domain Identity Management (SCIM) specification is designed to make managing user identities in cloud-based applications and services easier. The specification suite seeks to build upon experience with existing schemas and deployments, placing specific emphasis on simplicity of development and integration, while applying existing authentication, authorization, and privacy models. Its intent is to reduce the cost and complexity of user management operations by providing a common user schema and extension model, as well as binding documents to provide patterns for exchanging this schema using standard protocols. In essence: make it fast, cheap, and easy to move users in to, out of, and around the cloud.

Scim module exposes interface in CzechIdM by the SCIM 2.0 specification. Read more about SCIM model, operations and endpoints.

Installation

Dependencies

We are using a third party library scim2-sdk-common under LGPLv2 license. This library contains very useful DTOs (scim standard resources) and a filter parser. Rest endpoints are exposed by our devstack.

The Module can be installed in two ways:

Maven

This way is mainly for developer, when CzechIdM is opened in your favorite IDE. You can add maven dependency into idm-app pom.xml (or into other project specific (and used) module pom.xml): 

<dependency>
  <groupId>eu.bcvsolutions.idm</groupId>
  <artifactId>idm-scim-impl</artifactId>
  <version>1.0.1</version>
</dependency>

Third party dependencies will be included automatically.

Note: module has to be built locally - available in gitlab or access to our nexus has to be granted and repository included in the same pom.xml: 

<repository>
  <id>nexus</id>
  <name>Nexus private modules</name>
  <url>https://nexus.bcvsolutions.eu/repository/maven-modules-releases/</url>
</repository>

Standalone module

Module artefact (idm-scim-api, idm-scim-impl) can be downloaded from nexus releases and copied into installed CzechIdM server libraries <server>/WEB-INF/lib.

Third party library scim2-sdk-common in version 2.1.3 has to be copied into CzechIdM server libraries <server>/WEB-INF/lib too. Library can be built from github or downloaded from a public maven repository (e.g. central.maven.org).

After module is installed, run the CzechIdm and enable module by GUI (Setting → Modules) or by application properties: 

# enable scim module by default
idm.pub.scim.enabled=true

Architecture

Module is separated to two libraries - api and implementation. Api contains useful DTOs, which can be used for the client implementation: 

<dependency>
  <groupId>eu.bcvsolutions.idm</groupId>
  <artifactId>idm-scim-api</artifactId>
  <version>1.0.1</version>
</dependency>

Note: The same nexus repository has to be configured and access has to be granted as above.

API

Scim base path is available at url <server>/api/v1/scim. To simplify interoperability, SCIM provides three end points to discover supported features and specific attribute details:

Resources are exposed on endpoints by resource types (authentication is needed):

Security

Two authentication schemes is supported now:

Permissions

Module defines new permission group:

Standard CzechIdM authorization policies are not supported.

SCIM standard resources

Read more about SCIM model, operations and endpoints.

Standard scim schemas and resources rfc7643 are implemented with a few limitations:

User resource unsupported properties, which cannot be saved in CzechIdM:

This attributes are not implemented on the CzechIdM side by default, so when client try to save this attributes, exception with filled unsupported attribute name will be thrown. Custom module extension can be created, when attributes should be supported and saved in CzechIdM (with ScimUserService extension - override toDto and toResource methods and save attribute e.g. to custom extended attributes or into custom entity).

Implemented filter and sort properties on standard scim resources:

Filter supports equals (eq) operator and AND clause only. When other operator or clause is used, then unsupported operation will be thrown. Pagination startIndex and count parameter can be used. startIndex parameter is he 1-based index of the first query result. Start index has to be the first index on the page (n * count + 1), exception with code FIND_START_INDEX_INVALID is thrown otherwise (CzechIdM can paginate by the whole page only). Filter parameter has to be url encoded.

Standard CzechIdM filter properties can be used too, this is not in SCIM standard - e.g. <server>/api/v1/scim/Users?username=testOne is alias to SCIM standard <server>/api/v1/scim/Users?filter%3DuserName%20eq%20%22testOne%22.

If CzechIdM resource implements Codeable interface (e.g. User, Group, TreeType), then resource can be addressed additivelly by code in url and used in filter properties. E.q. <server>/api/v1/scim/Users/testOne will get user resource. UUID identifier can be used too.

Bulk operation is not supported.

Attribute names and values are case sensitive.

Custom schemas, resources and extensions

Module adds custom schema urn:ietf:params:scim:schemas:CzechIdM:8.1 with resources:

and extensions:

Available form definitions (and their attributes) for saving extended attribute values can be listed by FormDefinition resource type endpoint. Then extended form values can be saved together with resource (Resource has to implement FormableResource interface): 

{
   "schemas": [
     "urn:ietf:params:scim:schemas:core:2.0:User",
     "urn:ietf:params:scim:schemas:CzechIdM:8.1:Form"
    ],
   "userName": "scimOne",
   "urn:ietf:params:scim:schemas:CzechIdM:8.1:Form": {
   "forms" : [{
   		"code": "default",
   		"attributes": [{
   				"code": "extArtrOne",
  				"values": [{
   				      "shortTextValue": "test"
  				}]
   		}
   	]
   }
   ]}
}

As you can see, you don't need to know the exact form definition and attributes uuid identifiers - code can be given instead, but an uuid identifier can be used, too (alias). When request with resource is sent (POST / PUT / PATCH), then uuid identifiers are returned for saved resources. The saved value identifier has to be used, when value has to be updated, otherwise value will be recreated (⇒ drop and create).

Swagger

To expose swagger documentation endpoints, application property has to be configured: 

## Swagger config
# enable swagger endpoint (can be disabled for development etc.)
springfox.documentation.swagger.enabled=true

Then swagger documentation will be available at url <server>/swagger-ui.html.

This property is configured in test and production profile by default.

Read more

Devel tutorials

← Modules - SMS [sms] 
Documentation  
 Conventions →