SAML2 Metadata Management

The following CAS endpoints handle the generation of SAML2 metadata:

/idp/metadata

This endpoint will display the CAS IdP SAML2 metadata upon receiving a GET request. If metadata is already available and generated, it will be displayed. If metadata is absent, one will be generated automatically. CAS configuration below dictates where metadata files/keys will be generated and stored.

Note that the endpoint can accept a service parameter either by entity id or numeric identifier. This parameter is matched against the CAS service registry allowing the endpoint to calculate and combine any identity provider metadata overrides that may have been specified.

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.}

_{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.authn.saml-idp.metadata.core.cache-expiration=PT24H

How long should metadata be cached.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.saml-idp.metadata.core.cache-expiration=PT24H

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          cache-expiration: "PT24H"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.saml-idp.metadata.core.cache-expiration="PT24H" -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_SAML_IDP_METADATA_CORE_CACHE_EXPIRATION="PT24H"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.cache-expiration="PT24H"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.saml-idp.metadata.core.cache-maximum-size=10000

Specifies the maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn't been used recently or very often.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.saml-idp.metadata.core.cache-maximum-size=10000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          cache-maximum-size: "10000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.saml-idp.metadata.core.cache-maximum-size="10000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_SAML_IDP_METADATA_CORE_CACHE_MAXIMUM_SIZE="10000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.cache-maximum-size="10000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.saml-idp.metadata.core.fail-fast=true

Whether invalid metadata should eagerly fail quickly on startup once the resource is parsed.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.saml-idp.metadata.core.fail-fast=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          fail-fast: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.saml-idp.metadata.core.fail-fast="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_SAML_IDP_METADATA_CORE_FAIL_FAST="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.fail-fast="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.saml-idp.metadata.core.require-valid-metadata=true

Whether valid metadata is required.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.saml-idp.metadata.core.require-valid-metadata=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          require-valid-metadata: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.saml-idp.metadata.core.require-valid-metadata="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_SAML_IDP_METADATA_CORE_REQUIRE_VALID_METADATA="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.require-valid-metadata="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.saml-idp.metadata.core.slo-service-post-binding-enabled=true

Whether metadata generation process should support SLO service POST binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.saml-idp.metadata.core.slo-service-post-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          slo-service-post-binding-enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.saml-idp.metadata.core.slo-service-post-binding-enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_SAML_IDP_METADATA_CORE_SLO_SERVICE_POST_BINDING_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.slo-service-post-binding-enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.saml-idp.metadata.core.slo-service-redirect-binding-enabled=true

Whether metadata generation process should support SLO service REDIRECT binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.saml-idp.metadata.core.slo-service-redirect-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          slo-service-redirect-binding-enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.saml-idp.metadata.core.slo-service-redirect-binding-enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_SAML_IDP_METADATA_CORE_SLO_SERVICE_REDIRECT_BINDING_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.slo-service-redirect-binding-enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.saml-idp.metadata.core.sso-service-post-binding-enabled=true

Whether metadata generation process should support SSO service POST binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.saml-idp.metadata.core.sso-service-post-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          sso-service-post-binding-enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.saml-idp.metadata.core.sso-service-post-binding-enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_SAML_IDP_METADATA_CORE_SSO_SERVICE_POST_BINDING_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.sso-service-post-binding-enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.saml-idp.metadata.core.sso-service-post-simple-sign-binding-enabled=true

Whether metadata generation process should support SSO service POST SimpleSign binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.saml-idp.metadata.core.sso-service-post-simple-sign-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          sso-service-post-simple-sign-binding-enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.saml-idp.metadata.core.sso-service-post-simple-sign-binding-enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_SAML_IDP_METADATA_CORE_SSO_SERVICE_POST_SIMPLE_SIGN_BINDING_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.sso-service-post-simple-sign-binding-enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.saml-idp.metadata.core.sso-service-redirect-binding-enabled=true

Whether metadata generation process should support SSO service REDIRECT binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.saml-idp.metadata.core.sso-service-redirect-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          sso-service-redirect-binding-enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.saml-idp.metadata.core.sso-service-redirect-binding-enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_SAML_IDP_METADATA_CORE_SSO_SERVICE_REDIRECT_BINDING_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.sso-service-redirect-binding-enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.saml-idp.metadata.core.sso-service-soap-binding-enabled=true

Whether metadata generation process should support SSO service SOAP binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.saml-idp.metadata.core.sso-service-soap-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          sso-service-soap-binding-enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.saml-idp.metadata.core.sso-service-soap-binding-enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_SAML_IDP_METADATA_CORE_SSO_SERVICE_SOAP_BINDING_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.sso-service-soap-binding-enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.