===== Modules - SCIM: module installation =====

==== Dependencies ====

We are using a third party library [[https://github.com/pingidentity/scim2|scim2-sdk-common]] under LGPLv2 license. This library contains very useful DTOs (scim standard resources) and filter parser. Rest endpoints are exposed by our devstack.

Module can be installed both ways:

==== Maven ====

This way is mainly for a 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):

<code xml>
<dependency>
  <groupId>eu.bcvsolutions.idm</groupId>
  <artifactId>idm-scim-impl</artifactId>
  <version>2.2.0</version>
</dependency>
</code>

Third-party dependencies will be included automatically.

Note: the module has to be built locally - available in [[https://git.bcvsolutions.eu/modules/scim|gitlab]] or access to our [[https://nexus.bcvsolutions.eu/#browse/browse/components:maven-modules-releases|nexus]] has to be granted and repository included in the same pom.xml:

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

==== Standalone module ====

Module artefact (idm-scim-api, idm-scim-impl) can be downloaded from [[https://nexus.bcvsolutions.eu/#browse/browse/components:maven-modules-releases|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 [[https://github.com/pingidentity/scim2|github]] or downloaded from a public maven repository (e.g. [[http://central.maven.org/maven2/com/unboundid/product/scim2/scim2-sdk-common/2.1.3/scim2-sdk-common-2.1.3.jar|central.maven.org]]).

After module is installed, run the CzechIdm and enable module by GUI (Setting -> Modules) or by application properties:
<code properties>
# enable scim module by default
idm.pub.scim.enabled=true
</code>