Overview

The SCIM standard is created to simplify user management and provisioning in the cloud by defining a schema for representing users and groups and a REST API for all the necessary CRUD operations. SCIM integrations with CAS allow deployers to auto-provision the authenticated CAS principal to a SCIM server/target with additional support to map principal attributes into the appropriate claims and properties of the user resource.

SCIM v2 is supported, thanks to the SDK provided by UnboundID.

SCIM v1 Usage

This feature is deprecated and is scheduled to be removed in the future.

Typical use case for enabling SCIM is to synchronize and provision user accounts, just in time, to services and applications that are integrated with CAS for single sign-on. In cases where the application also has its own account store, a mapping of user accounts between the CAS canonical account store (LDAP, JDBC, etc) and the application may be required. To accommodate this issue, CAS may be allowed to provision the authenticated principal via SCIM to a provisioning/identity/entity engine which would then dynamically synchronize user profiles to target systems.

Configuration

Support is enabled by including the following dependency in the WAR overlay:

1
2
3
4
5
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-scim</artifactId>
    <version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-scim:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-scim"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
    /*
    The following platform references should be included automatically and are listed here for reference only.
            
    implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
    implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
    */

    implementation "org.apereo.cas:cas-server-support-scim"
}

The following settings and properties are available from the CAS configuration catalog:

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

  • cas.scim.oauth-token=
  • Authenticate into the SCIM server/service via a pre-generated OAuth token.

    org.apereo.cas.configuration.model.support.scim.ScimProperties.

    How can I configure this property?

  • cas.scim.password=
  • Authenticate into the SCIM server with a pre-defined password.

    org.apereo.cas.configuration.model.support.scim.ScimProperties.

    How can I configure this property?

  • cas.scim.target=
  • The SCIM provisioning target URI.

    org.apereo.cas.configuration.model.support.scim.ScimProperties.

    How can I configure this property?

  • cas.scim.username=
  • Authenticate into the SCIM server with a pre-defined username.

    org.apereo.cas.configuration.model.support.scim.ScimProperties.

    How can I configure this property?

    The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. You should only include this field in your configuration if you need to modify the default value.

  • cas.scim.enabled=true
  • Decide whether scim should be enabled.

    org.apereo.cas.configuration.model.support.scim.ScimProperties.

    How can I configure this property?

  • cas.scim.version=2
  • Indicate what version of the scim protocol is and should be used.

    org.apereo.cas.configuration.model.support.scim.ScimProperties.

    How can I configure this property?