Google Authenticator Authentication

Google Authenticator generates 2-step verification codes on your phone. With 2-step verification signing in will require a code generated by the Google Authenticator app in addition to primary authentication. Learn more about the topic here.

Note that the functionality presented here should also be compatible with the likes of LastPass Authenticator, etc.

Configuration

Support is enabled by including the following module in the overlay:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-gauth</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-gauth:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-gauth"
}

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-gauth"
}

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.authn.mfa.gauth.core.scratch-codes.encryption.key=

The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

_{How can I configure this property?}

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

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.mfa.gauth.core.scratch-codes.encryption.key=...

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: 
    mfa: 
      gauth: 
        core: 
          scratch-codes: 
            encryption: 
              key: "..."

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.mfa.gauth.core.scratch-codes.encryption.key="..." -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_MFA_GAUTH_CORE_SCRATCH_CODES_ENCRYPTION_KEY="..."

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.mfa.gauth.core.scratch-codes.encryption.key="..."

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.mfa.gauth.crypto.encryption.key=

The encryption key is a JWT whose length is defined by the encryption key size setting.

org.apereo.cas.configuration.model.core.util.EncryptionJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.encryption.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          encryption: 
            key: "..."

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.mfa.gauth.crypto.encryption.key="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_ENCRYPTION_KEY="..."

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.mfa.gauth.crypto.encryption.key="..."

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.mfa.gauth.crypto.signing.key=

The signing key is a JWT whose length is defined by the signing key size setting.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.signing.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          signing: 
            key: "..."

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.mfa.gauth.crypto.signing.key="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_SIGNING_KEY="..."

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.mfa.gauth.crypto.signing.key="..."

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.mfa.gauth.core.issuer=CASIssuer

Issuer used in the barcode when dealing with device registration events. Used in the registration URL to identify CAS.

org.apereo.cas.configuration.model.support.mfa.gauth.CoreGoogleAuthenticatorMultifactorProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.core.issuer=CASIssuer

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        core: 
          issuer: "CASIssuer"

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.mfa.gauth.core.issuer="CASIssuer" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CORE_ISSUER="CASIssuer"

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.mfa.gauth.core.issuer="CASIssuer"

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.mfa.gauth.core.label=CASLabel

Label used in the barcode when dealing with device registration events. Used in the registration URL to identify CAS.

org.apereo.cas.configuration.model.support.mfa.gauth.CoreGoogleAuthenticatorMultifactorProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.core.label=CASLabel

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        core: 
          label: "CASLabel"

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.mfa.gauth.core.label="CASLabel" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CORE_LABEL="CASLabel"

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.mfa.gauth.core.label="CASLabel"

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.

_{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. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

cas.authn.mfa.gauth.core.scratch-codes.encryption.key-size=16

Encryption key size.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.core.scratch-codes.encryption.key-size=16

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        core: 
          scratch-codes: 
            encryption: 
              key-size: "16"

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.mfa.gauth.core.scratch-codes.encryption.key-size="16" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CORE_SCRATCH_CODES_ENCRYPTION_KEY_SIZE="16"

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.mfa.gauth.core.scratch-codes.encryption.key-size="16"

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.mfa.gauth.crypto.alg=

The signing/encryption algorithm to use.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.alg=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          alg: "..."

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.mfa.gauth.crypto.alg="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_ALG="..."

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.mfa.gauth.crypto.alg="..."

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.mfa.gauth.crypto.enabled=true

Whether crypto operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          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.mfa.gauth.crypto.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_MFA_GAUTH_CRYPTO_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.mfa.gauth.crypto.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.mfa.gauth.crypto.encryption.key-size=512

The encryption key size.

org.apereo.cas.configuration.model.core.util.EncryptionJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.encryption.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          encryption: 
            key-size: "512"

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.mfa.gauth.crypto.encryption.key-size="512" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_ENCRYPTION_KEY_SIZE="512"

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.mfa.gauth.crypto.encryption.key-size="512"

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.mfa.gauth.crypto.signing.key-size=512

The signing key size.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.signing.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          signing: 
            key-size: "512"

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.mfa.gauth.crypto.signing.key-size="512" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_SIGNING_KEY_SIZE="512"

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.mfa.gauth.crypto.signing.key-size="512"

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.mfa.gauth.crypto.strategy-type=ENCRYPT_AND_SIGN

Control the cipher sequence of operations. The accepted values are:

ENCRYPT_AND_SIGN: Encrypt the value first, and then sign.
SIGN_AND_ENCRYPT: Sign the value first, and then encrypt.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.strategy-type=ENCRYPT_AND_SIGN

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          strategy-type: "ENCRYPT_AND_SIGN"

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.mfa.gauth.crypto.strategy-type="ENCRYPT_AND_SIGN" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_STRATEGY_TYPE="ENCRYPT_AND_SIGN"

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.mfa.gauth.crypto.strategy-type="ENCRYPT_AND_SIGN"

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.mfa.gauth.core.code-digits=6

Length of the generated code.

org.apereo.cas.configuration.model.support.mfa.gauth.CoreGoogleAuthenticatorMultifactorProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.core.code-digits=6

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        core: 
          code-digits: "6"

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.mfa.gauth.core.code-digits="6" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CORE_CODE_DIGITS="6"

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.mfa.gauth.core.code-digits="6"

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.mfa.gauth.core.multiple-device-registration-enabled=false

When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically.

org.apereo.cas.configuration.model.support.mfa.gauth.CoreGoogleAuthenticatorMultifactorProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.core.multiple-device-registration-enabled=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        core: 
          multiple-device-registration-enabled: "..."

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.mfa.gauth.core.multiple-device-registration-enabled="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CORE_MULTIPLE_DEVICE_REGISTRATION_ENABLED="..."

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.mfa.gauth.core.multiple-device-registration-enabled="..."

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.mfa.gauth.core.time-step-size=30

The expiration time of the generated code in seconds.

org.apereo.cas.configuration.model.support.mfa.gauth.CoreGoogleAuthenticatorMultifactorProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.core.time-step-size=30

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        core: 
          time-step-size: "30"

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.mfa.gauth.core.time-step-size="30" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CORE_TIME_STEP_SIZE="30"

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.mfa.gauth.core.time-step-size="30"

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.mfa.gauth.core.trusted-device-enabled=false

Indicates whether this provider should support trusted devices.

org.apereo.cas.configuration.model.support.mfa.gauth.CoreGoogleAuthenticatorMultifactorProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.core.trusted-device-enabled=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        core: 
          trusted-device-enabled: "..."

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.mfa.gauth.core.trusted-device-enabled="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CORE_TRUSTED_DEVICE_ENABLED="..."

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.mfa.gauth.core.trusted-device-enabled="..."

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.mfa.gauth.core.window-size=3

Since TOTP passwords are time-based, it is essential that the clock of both the server and the client are synchronised within the tolerance defined here as the window size.

org.apereo.cas.configuration.model.support.mfa.gauth.CoreGoogleAuthenticatorMultifactorProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.core.window-size=3

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        core: 
          window-size: "3"

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.mfa.gauth.core.window-size="3" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CORE_WINDOW_SIZE="3"

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.mfa.gauth.core.window-size="3"

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.

# Encryption key size.
# cas.authn.mfa.gauth.core.scratch-codes.encryption.key-size=16

# The signing/encryption algorithm to use.
# cas.authn.mfa.gauth.crypto.alg=

# Whether crypto operations are enabled.
# cas.authn.mfa.gauth.crypto.enabled=true

# The encryption key size.
# cas.authn.mfa.gauth.crypto.encryption.key-size=512

# The signing key size.
# cas.authn.mfa.gauth.crypto.signing.key-size=512

# Control the cipher sequence of operations.
# cas.authn.mfa.gauth.crypto.strategy-type=ENCRYPT_AND_SIGN

# Length of the generated code.
# cas.authn.mfa.gauth.core.code-digits=6

# When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically.
# cas.authn.mfa.gauth.core.multiple-device-registration-enabled=false

# The expiration time of the generated code in seconds.
# cas.authn.mfa.gauth.core.time-step-size=30

# Indicates whether this provider should support trusted devices.
# cas.authn.mfa.gauth.core.trusted-device-enabled=false

# Since TOTP passwords are time-based, it is essential that the clock of both the server and the client are synchronised within the tolerance defined here as the window size.
# cas.authn.mfa.gauth.core.window-size=3

cas.authn.mfa.gauth.crypto.encryption.key=

The encryption key is a JWT whose length is defined by the encryption key size setting.

org.apereo.cas.configuration.model.core.util.EncryptionJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.encryption.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          encryption: 
            key: "..."

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.mfa.gauth.crypto.encryption.key="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_ENCRYPTION_KEY="..."

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.mfa.gauth.crypto.encryption.key="..."

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.mfa.gauth.crypto.signing.key=

The signing key is a JWT whose length is defined by the signing key size setting.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.signing.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          signing: 
            key: "..."

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.mfa.gauth.crypto.signing.key="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_SIGNING_KEY="..."

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.mfa.gauth.crypto.signing.key="..."

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.mfa.gauth.crypto.alg=

The signing/encryption algorithm to use.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.alg=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          alg: "..."

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.mfa.gauth.crypto.alg="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_ALG="..."

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.mfa.gauth.crypto.alg="..."

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.mfa.gauth.crypto.enabled=true

Whether crypto operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          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.mfa.gauth.crypto.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_MFA_GAUTH_CRYPTO_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.mfa.gauth.crypto.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.mfa.gauth.crypto.encryption.key-size=512

The encryption key size.

org.apereo.cas.configuration.model.core.util.EncryptionJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.encryption.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          encryption: 
            key-size: "512"

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.mfa.gauth.crypto.encryption.key-size="512" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_ENCRYPTION_KEY_SIZE="512"

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.mfa.gauth.crypto.encryption.key-size="512"

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.mfa.gauth.crypto.signing.key-size=512

The signing key size.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.signing.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          signing: 
            key-size: "512"

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.mfa.gauth.crypto.signing.key-size="512" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_SIGNING_KEY_SIZE="512"

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.mfa.gauth.crypto.signing.key-size="512"

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.mfa.gauth.crypto.strategy-type=ENCRYPT_AND_SIGN

Control the cipher sequence of operations. The accepted values are:

ENCRYPT_AND_SIGN: Encrypt the value first, and then sign.
SIGN_AND_ENCRYPT: Sign the value first, and then encrypt.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.crypto.strategy-type=ENCRYPT_AND_SIGN

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        crypto: 
          strategy-type: "ENCRYPT_AND_SIGN"

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.mfa.gauth.crypto.strategy-type="ENCRYPT_AND_SIGN" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_CRYPTO_STRATEGY_TYPE="ENCRYPT_AND_SIGN"

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.mfa.gauth.crypto.strategy-type="ENCRYPT_AND_SIGN"

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.

This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.

Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:

wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]

The outcome would be similar to:

{
  "kty": "oct",
  "kid": "...",
  "k": "..."
}

The generated value for k needs to be assigned to the relevant CAS settings. Note that keys generated via the above algorithm are processed by CAS using the Advanced Encryption Standard (AES) algorithm which is a specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

Note

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

Bypass

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

cas.authn.mfa.gauth.bypass.groovy.location=

The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system.

In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number of inotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256.

You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.

In situations and scenarios where CAS is able to automatically watch the underlying resource for changes and detect updates and modifications dynamically, you may be able to specify the following setting as either an environment variable or system property with a value of false to disable the resource watcher: org.apereo.cas.util.io.PathWatcherService.

org.apereo.cas.configuration.model.support.mfa.GroovyMultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.groovy.location=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          groovy: 
            location: "..."

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.mfa.gauth.bypass.groovy.location="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_GROOVY_LOCATION="..."

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.mfa.gauth.bypass.groovy.location="..."

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.mfa.gauth.bypass.rest.url=

The endpoint URL to contact and retrieve attributes.

org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.rest.url=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          rest: 
            url: "..."

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.mfa.gauth.bypass.rest.url="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_REST_URL="..."

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.mfa.gauth.bypass.rest.url="..."

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.mfa.gauth.bypass.authentication-attribute-name=

Skip multifactor authentication based on designated authentication attribute names.

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.authentication-attribute-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          authentication-attribute-name: "..."

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.mfa.gauth.bypass.authentication-attribute-name="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_AUTHENTICATION_ATTRIBUTE_NAME="..."

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.mfa.gauth.bypass.authentication-attribute-name="..."

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.mfa.gauth.bypass.authentication-attribute-value=

Optionally, skip multifactor authentication based on designated authentication attribute values. Multiple values may be separated by a comma.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.authentication-attribute-value=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          authentication-attribute-value: "..."

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.mfa.gauth.bypass.authentication-attribute-value="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_AUTHENTICATION_ATTRIBUTE_VALUE="..."

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.mfa.gauth.bypass.authentication-attribute-value="..."

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.mfa.gauth.bypass.authentication-handler-name=

Skip multifactor authentication depending on form of primary authentication execution. Specifically, skip multifactor if the a particular authentication handler noted by its name successfully is able to authenticate credentials in the primary factor. Multiple values may be separated by a comma.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.authentication-handler-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          authentication-handler-name: "..."

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.mfa.gauth.bypass.authentication-handler-name="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_AUTHENTICATION_HANDLER_NAME="..."

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.mfa.gauth.bypass.authentication-handler-name="..."

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.mfa.gauth.bypass.authentication-method-name=

Skip multifactor authentication depending on method/form of primary authentication execution. Specifically, skip multifactor if the authentication method attribute collected as part of authentication metadata matches a certain value. Multiple values may be separated by a comma.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.authentication-method-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          authentication-method-name: "..."

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.mfa.gauth.bypass.authentication-method-name="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_AUTHENTICATION_METHOD_NAME="..."

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.mfa.gauth.bypass.authentication-method-name="..."

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.mfa.gauth.bypass.credential-class-type=

Skip multifactor authentication depending on form of primary credentials. Value must equal the fully qualified class name of the credential type.

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.credential-class-type=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          credential-class-type: "..."

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.mfa.gauth.bypass.credential-class-type="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_CREDENTIAL_CLASS_TYPE="..."

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.mfa.gauth.bypass.credential-class-type="..."

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.mfa.gauth.bypass.http-request-headers=

Skip multifactor authentication if the http request contains the defined header names. Header names may be comma-separated and can be regular expressions; values are ignored.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.http-request-headers=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          http-request-headers: "..."

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.mfa.gauth.bypass.http-request-headers="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_HTTP_REQUEST_HEADERS="..."

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.mfa.gauth.bypass.http-request-headers="..."

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.mfa.gauth.bypass.http-request-remote-address=

Skip multifactor authentication if the http request's remote address or host matches the value defined here. The value may be specified as a regular expression.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.http-request-remote-address=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          http-request-remote-address: "..."

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.mfa.gauth.bypass.http-request-remote-address="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_HTTP_REQUEST_REMOTE_ADDRESS="..."

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.mfa.gauth.bypass.http-request-remote-address="..."

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.mfa.gauth.bypass.principal-attribute-name=

Skip multifactor authentication based on designated principal attribute names.

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.principal-attribute-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          principal-attribute-name: "..."

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.mfa.gauth.bypass.principal-attribute-name="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_PRINCIPAL_ATTRIBUTE_NAME="..."

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.mfa.gauth.bypass.principal-attribute-name="..."

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.mfa.gauth.bypass.principal-attribute-value=

Optionally, skip multifactor authentication based on designated principal attribute values.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.principal-attribute-value=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          principal-attribute-value: "..."

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.mfa.gauth.bypass.principal-attribute-value="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_PRINCIPAL_ATTRIBUTE_VALUE="..."

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.mfa.gauth.bypass.principal-attribute-value="..."

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.mfa.gauth.bypass.rest.basic-auth-password=

If REST endpoint is protected via basic authentication, specify the password for authentication.

org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.rest.basic-auth-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          rest: 
            basic-auth-password: "..."

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.mfa.gauth.bypass.rest.basic-auth-password="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_REST_BASIC_AUTH_PASSWORD="..."

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.mfa.gauth.bypass.rest.basic-auth-password="..."

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.mfa.gauth.bypass.rest.basic-auth-username=

If REST endpoint is protected via basic authentication, specify the username for authentication.

org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.rest.basic-auth-username=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          rest: 
            basic-auth-username: "..."

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.mfa.gauth.bypass.rest.basic-auth-username="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_REST_BASIC_AUTH_USERNAME="..."

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.mfa.gauth.bypass.rest.basic-auth-username="..."

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.mfa.gauth.bypass.rest.headers=

Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value.

org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.rest.headers=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          rest: 
            headers: "..."

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.mfa.gauth.bypass.rest.headers="..." -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_REST_HEADERS="..."

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.mfa.gauth.bypass.rest.headers="..."

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.mfa.gauth.bypass.rest.method=GET

HTTP method to use when contacting the rest endpoint. Examples include GET, POST, etc.

org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.mfa.gauth.bypass.rest.method=GET

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      gauth: 
        bypass: 
          rest: 
            method: "GET"

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.mfa.gauth.bypass.rest.method="GET" -jar build/libs/cas.war

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

export CAS_AUTHN_MFA_GAUTH_BYPASS_REST_METHOD="GET"

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.mfa.gauth.bypass.rest.method="GET"

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.

# Skip multifactor authentication based on designated authentication attribute names.
# cas.authn.mfa.gauth.bypass.authentication-attribute-name=

# Optionally, skip multifactor authentication based on designated authentication attribute values.
# cas.authn.mfa.gauth.bypass.authentication-attribute-value=

# Skip multifactor authentication depending on form of primary authentication execution.
# cas.authn.mfa.gauth.bypass.authentication-handler-name=

# Skip multifactor authentication depending on method/form of primary authentication execution.
# cas.authn.mfa.gauth.bypass.authentication-method-name=

# Skip multifactor authentication depending on form of primary credentials.
# cas.authn.mfa.gauth.bypass.credential-class-type=

# Skip multifactor authentication if the http request contains the defined header names.
# cas.authn.mfa.gauth.bypass.http-request-headers=

# Skip multifactor authentication if the http request's remote address or host matches the value defined here.
# cas.authn.mfa.gauth.bypass.http-request-remote-address=

# Skip multifactor authentication based on designated principal attribute names.
# cas.authn.mfa.gauth.bypass.principal-attribute-name=

# Optionally, skip multifactor authentication based on designated principal attribute values.
# cas.authn.mfa.gauth.bypass.principal-attribute-value=

# If REST endpoint is protected via basic authentication, specify the password for authentication.
# cas.authn.mfa.gauth.bypass.rest.basic-auth-password=

# If REST endpoint is protected via basic authentication, specify the username for authentication.
# cas.authn.mfa.gauth.bypass.rest.basic-auth-username=

# Headers, defined as a Map, to include in the request when making the REST call.
# cas.authn.mfa.gauth.bypass.rest.headers=

# HTTP method to use when contacting the rest endpoint.
# cas.authn.mfa.gauth.bypass.rest.method=GET

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Note

Validation

Indexed Settings

Actuator Endpoints

The following endpoints are provided by CAS:

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

cas.monitor.endpoints.jdbc.password-encoder.encoding-algorithm=

The encoding algorithm to use such as MD5. Relevant when the type used is DEFAULT or GLIBC_CRYPT. When used with PasswordEncoderTypes#PBKDF2, it should be one of PBKDF2WithHmacSHA1, PBKDF2WithHmacSHA256 or PBKDF2WithHmacSHA512.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.encoding-algorithm=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          encoding-algorithm: "..."

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.monitor.endpoints.jdbc.password-encoder.encoding-algorithm="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_ENCODING_ALGORITHM="..."

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.monitor.endpoints.jdbc.password-encoder.encoding-algorithm="..."

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.monitor.endpoints.jdbc.password-encoder.type=NONE

Define the password encoder type to use. Type may be specified as blank or NONE to disable password encoding. It may also refer to a fully-qualified class name that implements the Spring Security's PasswordEncoder interface if you wish you define your own encoder.

The following types may be used:

NONE: No password encoding (i.e. plain-text) takes place.
DEFAULT: Use the DefaultPasswordEncoder of CAS. For message-digest algorithms via character-encoding and encoding-algorithm.
BCRYPT: Use the BCryptPasswordEncoder based on the strength provided and an optional secret.
SCRYPT: Use the SCryptPasswordEncoder.
PBKDF2: Use the Pbkdf2PasswordEncoder based on the strength provided and an optional secret.
STANDARD: Use the StandardPasswordEncoder based on the secret provided.
SSHA: Use the LdapShaPasswordEncoder supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA} or {SSHA} prepended to the encoded hash.
GLIBC_CRYPT: Use the GlibcCryptPasswordEncoder based on the encoding-algorithm, strength provided and an optional secret.
org.example.MyEncoder: An implementation of PasswordEncoder of your own choosing.
file:///path/to/script.groovy: Path to a Groovy script charged with handling password encoding operations.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.type=NONE

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          type: "NONE"

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.monitor.endpoints.jdbc.password-encoder.type="NONE" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_TYPE="NONE"

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.monitor.endpoints.jdbc.password-encoder.type="NONE"

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.monitor.endpoints.jdbc.driver-class=org.hsqldb.jdbcDriver

The JDBC driver used to connect to the database.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.driver-class=org.hsqldb.jdbcDriver

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        driver-class: "org.hsqldb.jdbcDriver"

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.monitor.endpoints.jdbc.driver-class="org.hsqldb.jdbcDriver" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_DRIVER_CLASS="org.hsqldb.jdbcDriver"

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.monitor.endpoints.jdbc.driver-class="org.hsqldb.jdbcDriver"

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.monitor.endpoints.jdbc.password=

The database connection password.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password: "..."

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.monitor.endpoints.jdbc.password="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD="..."

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.monitor.endpoints.jdbc.password="..."

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.monitor.endpoints.jdbc.url=jdbc:hsqldb:mem:cas-hsql-database

The database connection URL.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.url=jdbc:hsqldb:mem:cas-hsql-database

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        url: "jdbc:hsqldb:mem:cas-hsql-database"

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.monitor.endpoints.jdbc.url="jdbc:hsqldb:mem:cas-hsql-database" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_URL="jdbc:hsqldb:mem:cas-hsql-database"

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.monitor.endpoints.jdbc.url="jdbc:hsqldb:mem:cas-hsql-database"

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.monitor.endpoints.jdbc.user=sa

The database user.

The database user must have sufficient permissions to be able to handle schema changes and updates, when needed.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.user=sa

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        user: "sa"

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.monitor.endpoints.jdbc.user="sa" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_USER="sa"

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.monitor.endpoints.jdbc.user="sa"

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.monitor.endpoints.jdbc.password-encoder.character-encoding=UTF-8

The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is DEFAULT.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.character-encoding=UTF-8

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          character-encoding: "UTF-8"

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.monitor.endpoints.jdbc.password-encoder.character-encoding="UTF-8" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_CHARACTER_ENCODING="UTF-8"

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.monitor.endpoints.jdbc.password-encoder.character-encoding="UTF-8"

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.monitor.endpoints.jdbc.password-encoder.hash-length=16

When used by PasswordEncoderTypes#ARGON2, it indicates the hash strength/length.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.hash-length=16

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          hash-length: "16"

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.monitor.endpoints.jdbc.password-encoder.hash-length="16" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_HASH_LENGTH="16"

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.monitor.endpoints.jdbc.password-encoder.hash-length="16"

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.monitor.endpoints.jdbc.password-encoder.iterations=310000

When used by PasswordEncoderTypes#PBKDF2, it indicates the required number of iterations.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.iterations=310000

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          iterations: "310000"

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.monitor.endpoints.jdbc.password-encoder.iterations="310000" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_ITERATIONS="310000"

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.monitor.endpoints.jdbc.password-encoder.iterations="310000"

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.monitor.endpoints.jdbc.password-encoder.secret=

Secret to use with PasswordEncoderTypes#STANDARD, PasswordEncoderTypes#PBKDF2, PasswordEncoderTypes#BCRYPT, PasswordEncoderTypes#GLIBC_CRYPT password encoders. Secret usually is an optional setting.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.secret=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          secret: "..."

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.monitor.endpoints.jdbc.password-encoder.secret="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_SECRET="..."

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.monitor.endpoints.jdbc.password-encoder.secret="..."

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.monitor.endpoints.jdbc.password-encoder.strength=16

Strength or number of iterations to use for password hashing. Usually relevant when dealing with PasswordEncoderTypes#BCRYPT, PasswordEncoderTypes#PBKDF2 or PasswordEncoderTypes#GLIBC_CRYPT. When used by PasswordEncoderTypes#ARGON2 or PasswordEncoderTypes#PBKDF2, it indicates the salt strength.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.strength=16

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          strength: "16"

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.monitor.endpoints.jdbc.password-encoder.strength="16" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_STRENGTH="16"

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.monitor.endpoints.jdbc.password-encoder.strength="16"

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.monitor.endpoints.jdbc.autocommit=false

The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.autocommit=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        autocommit: "..."

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.monitor.endpoints.jdbc.autocommit="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_AUTOCOMMIT="..."

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.monitor.endpoints.jdbc.autocommit="..."

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.monitor.endpoints.jdbc.batch-size=100

A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.batch-size=100

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        batch-size: "100"

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.monitor.endpoints.jdbc.batch-size="100" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_BATCH_SIZE="100"

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.monitor.endpoints.jdbc.batch-size="100"

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.monitor.endpoints.jdbc.data-source-name=

Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.data-source-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        data-source-name: "..."

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.monitor.endpoints.jdbc.data-source-name="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_DATA_SOURCE_NAME="..."

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.monitor.endpoints.jdbc.data-source-name="..."

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.monitor.endpoints.jdbc.ddl-auto=update

Hibernate feature to automatically validate and exports DDL to the schema. By default, creates and drops the schema automatically when a session is starts and ends. Setting the value to validate or none may be more desirable for production, but any of the following options can be used:

validate: Validate the schema, but make no changes to the database.
update: Update the schema.
create: Create the schema, destroying previous data.
create-drop: Drop the schema at the end of the session.
none: Do nothing.

Note that during a version migration where any schema has changed create-drop will result in the loss of all data as soon as CAS is started. For transient data like tickets this is probably not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe for data, is confirmed to result in invalid database state. validate or none settings are likely the only safe options for production use.

For more info, see this.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.ddl-auto=update

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        ddl-auto: "update"

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.monitor.endpoints.jdbc.ddl-auto="update" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_DDL_AUTO="update"

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.monitor.endpoints.jdbc.ddl-auto="update"

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.monitor.endpoints.jdbc.default-catalog=

Qualifies unqualified table names with the given catalog in generated SQL.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.default-catalog=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        default-catalog: "..."

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.monitor.endpoints.jdbc.default-catalog="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_DEFAULT_CATALOG="..."

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.monitor.endpoints.jdbc.default-catalog="..."

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.monitor.endpoints.jdbc.default-schema=

Qualify unqualified table names with the given schema/tablespace in generated SQL.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.default-schema=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        default-schema: "..."

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.monitor.endpoints.jdbc.default-schema="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_DEFAULT_SCHEMA="..."

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.monitor.endpoints.jdbc.default-schema="..."

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.monitor.endpoints.jdbc.dialect=org.hibernate.dialect.HSQLDialect

The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.dialect=org.hibernate.dialect.HSQLDialect

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        dialect: "org.hibernate.dialect.HSQLDialect"

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.monitor.endpoints.jdbc.dialect="org.hibernate.dialect.HSQLDialect" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_DIALECT="org.hibernate.dialect.HSQLDialect"

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.monitor.endpoints.jdbc.dialect="org.hibernate.dialect.HSQLDialect"

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.monitor.endpoints.jdbc.fail-fast-timeout=1

Set the pool initialization failure timeout.

Any value greater than zero will be treated as a timeout for pool initialization. The calling thread will be blocked from continuing until a successful connection to the database, or until the timeout is reached. If the timeout is reached, then a PoolInitializationException will be thrown.
A value of zero will not prevent the pool from starting in the case that a connection cannot be obtained. However, upon start the pool will attempt to obtain a connection and validate that the connectionTestQuery and connectionInitSql are valid. If those validations fail, an exception will be thrown. If a connection cannot be obtained, the validation is skipped and the the pool will start and continue to try to obtain connections in the background. This can mean that callers to DataSource#getConnection() may encounter exceptions.
A value less than zero will not bypass any connection attempt and validation during startup, and therefore the pool will start immediately. The pool will continue to try to obtain connections in the background. This can mean that callers to DataSource#getConnection() may encounter exceptions.

Note that if this timeout value is greater than or equal to zero (0), and therefore an initial connection validation is performed, this timeout does not override the connectionTimeout or validationTimeout; they will be honored before this timeout is applied. The default value is one millisecond.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.fail-fast-timeout=1

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        fail-fast-timeout: "1"

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.monitor.endpoints.jdbc.fail-fast-timeout="1" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_FAIL_FAST_TIMEOUT="1"

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.monitor.endpoints.jdbc.fail-fast-timeout="1"

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.monitor.endpoints.jdbc.fetch-size=100

Used to specify number of rows to be fetched in a select query.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.fetch-size=100

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        fetch-size: "100"

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.monitor.endpoints.jdbc.fetch-size="100" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_FETCH_SIZE="100"

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.monitor.endpoints.jdbc.fetch-size="100"

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.monitor.endpoints.jdbc.generate-statistics=false

Allow hibernate to generate query statistics.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.generate-statistics=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        generate-statistics: "..."

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.monitor.endpoints.jdbc.generate-statistics="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_GENERATE_STATISTICS="..."

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.monitor.endpoints.jdbc.generate-statistics="..."

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.monitor.endpoints.jdbc.health-query=

The SQL query to be executed to test the validity of connections. This is for "legacy" databases that do not support the JDBC4 Connection.isValid() API.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.health-query=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        health-query: "..."

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.monitor.endpoints.jdbc.health-query="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_HEALTH_QUERY="..."

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.monitor.endpoints.jdbc.health-query="..."

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.monitor.endpoints.jdbc.idle-timeout=PT10M

Controls the maximum amount of time that a connection is allowed to sit idle in the pool.

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

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.idle-timeout=PT10M

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        idle-timeout: "PT10M"

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.monitor.endpoints.jdbc.idle-timeout="PT10M" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_IDLE_TIMEOUT="PT10M"

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.monitor.endpoints.jdbc.idle-timeout="PT10M"

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.monitor.endpoints.jdbc.isolate-internal-queries=false

This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.

Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if #autocommit is disabled.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.isolate-internal-queries=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        isolate-internal-queries: "..."

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.monitor.endpoints.jdbc.isolate-internal-queries="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_ISOLATE_INTERNAL_QUERIES="..."

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.monitor.endpoints.jdbc.isolate-internal-queries="..."

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.monitor.endpoints.jdbc.isolation-level-name=ISOLATION_READ_COMMITTED

Defines the isolation level for transactions. @see org.springframework.transaction.TransactionDefinition

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.isolation-level-name=ISOLATION_READ_COMMITTED

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        isolation-level-name: "ISOLATION_READ_COMMITTED"

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.monitor.endpoints.jdbc.isolation-level-name="ISOLATION_READ_COMMITTED" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_ISOLATION_LEVEL_NAME="ISOLATION_READ_COMMITTED"

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.monitor.endpoints.jdbc.isolation-level-name="ISOLATION_READ_COMMITTED"

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.monitor.endpoints.jdbc.leak-threshold=PT6S

Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.

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

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.leak-threshold=PT6S

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        leak-threshold: "PT6S"

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.monitor.endpoints.jdbc.leak-threshold="PT6S" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_LEAK_THRESHOLD="PT6S"

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.monitor.endpoints.jdbc.leak-threshold="PT6S"

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.monitor.endpoints.jdbc.physical-naming-strategy-class-name=org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy

Fully-qualified name of the class that can control the physical naming strategy of hibernate.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.physical-naming-strategy-class-name=org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        physical-naming-strategy-class-name: "org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy"

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.monitor.endpoints.jdbc.physical-naming-strategy-class-name="org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PHYSICAL_NAMING_STRATEGY_CLASS_NAME="org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy"

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.monitor.endpoints.jdbc.physical-naming-strategy-class-name="org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy"

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.monitor.endpoints.jdbc.propagation-behavior-name=PROPAGATION_REQUIRED

Defines the propagation behavior for transactions. @see org.springframework.transaction.TransactionDefinition

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.propagation-behavior-name=PROPAGATION_REQUIRED

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        propagation-behavior-name: "PROPAGATION_REQUIRED"

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.monitor.endpoints.jdbc.propagation-behavior-name="PROPAGATION_REQUIRED" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PROPAGATION_BEHAVIOR_NAME="PROPAGATION_REQUIRED"

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.monitor.endpoints.jdbc.propagation-behavior-name="PROPAGATION_REQUIRED"

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.monitor.endpoints.jdbc.properties=

Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.properties=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        properties: "..."

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.monitor.endpoints.jdbc.properties="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PROPERTIES="..."

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.monitor.endpoints.jdbc.properties="..."

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.monitor.endpoints.jdbc.query=

Query to execute in order to authenticate users via JDBC. Example: SELECT username,password,enabled FROM users WHERE username=?

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.query=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        query: "..."

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.monitor.endpoints.jdbc.query="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_QUERY="..."

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.monitor.endpoints.jdbc.query="..."

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.monitor.endpoints.jdbc.read-only=false

Configures the Connections to be added to the pool as read-only Connections.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.read-only=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        read-only: "..."

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.monitor.endpoints.jdbc.read-only="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_READ_ONLY="..."

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.monitor.endpoints.jdbc.read-only="..."

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.monitor.endpoints.jdbc.role-prefix=

Prefix to add to the role.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.role-prefix=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        role-prefix: "..."

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.monitor.endpoints.jdbc.role-prefix="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_ROLE_PREFIX="..."

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.monitor.endpoints.jdbc.role-prefix="..."

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.monitor.endpoints.jdbc.pool.keep-alive-time=0

This property controls the keepalive interval for a connection in the pool. An in-use connection will never be tested by the keepalive thread, only when it is idle will it be tested. Default is zero, which disables this feature.

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

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.pool.keep-alive-time=0

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        pool: 
          keep-alive-time: "0"

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.monitor.endpoints.jdbc.pool.keep-alive-time="0" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_POOL_KEEP_ALIVE_TIME="0"

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.monitor.endpoints.jdbc.pool.keep-alive-time="0"

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.monitor.endpoints.jdbc.pool.max-size=18

Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.pool.max-size=18

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        pool: 
          max-size: "18"

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.monitor.endpoints.jdbc.pool.max-size="18" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_POOL_MAX_SIZE="18"

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.monitor.endpoints.jdbc.pool.max-size="18"

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.monitor.endpoints.jdbc.pool.max-wait=PT2S

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.

A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout.

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

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.pool.max-wait=PT2S

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        pool: 
          max-wait: "PT2S"

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.monitor.endpoints.jdbc.pool.max-wait="PT2S" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_POOL_MAX_WAIT="PT2S"

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.monitor.endpoints.jdbc.pool.max-wait="PT2S"

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.monitor.endpoints.jdbc.pool.maximum-lifetime=PT10M

This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed.

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

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.pool.maximum-lifetime=PT10M

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        pool: 
          maximum-lifetime: "PT10M"

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.monitor.endpoints.jdbc.pool.maximum-lifetime="PT10M" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_POOL_MAXIMUM_LIFETIME="PT10M"

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.monitor.endpoints.jdbc.pool.maximum-lifetime="PT10M"

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.monitor.endpoints.jdbc.pool.min-size=6

Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.pool.min-size=6

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        pool: 
          min-size: "6"

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.monitor.endpoints.jdbc.pool.min-size="6" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_POOL_MIN_SIZE="6"

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.monitor.endpoints.jdbc.pool.min-size="6"

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.monitor.endpoints.jdbc.pool.name=

Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.pool.name=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        pool: 
          name: "..."

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.monitor.endpoints.jdbc.pool.name="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_POOL_NAME="..."

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.monitor.endpoints.jdbc.pool.name="..."

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.monitor.endpoints.jdbc.pool.suspension=false

Whether or not pool suspension is allowed.

There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.pool.suspension=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        pool: 
          suspension: "..."

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.monitor.endpoints.jdbc.pool.suspension="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_POOL_SUSPENSION="..."

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.monitor.endpoints.jdbc.pool.suspension="..."

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.monitor.endpoints.jdbc.pool.timeout-millis=1000

The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.pool.timeout-millis=1000

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        pool: 
          timeout-millis: "1000"

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.monitor.endpoints.jdbc.pool.timeout-millis="1000" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_POOL_TIMEOUT_MILLIS="1000"

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.monitor.endpoints.jdbc.pool.timeout-millis="1000"

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.

# The encoding algorithm to use such as 'UTF-8'.
# cas.monitor.endpoints.jdbc.password-encoder.character-encoding=UTF-8

# When used by {@link PasswordEncoderTypes#ARGON2}, it indicates the hash strength/length.
# cas.monitor.endpoints.jdbc.password-encoder.hash-length=16

# When used by {@link PasswordEncoderTypes#PBKDF2}, it indicates the required number of iterations.
# cas.monitor.endpoints.jdbc.password-encoder.iterations=310000

# Secret to use with {@link PasswordEncoderTypes#STANDARD}, {@link PasswordEncoderTypes#PBKDF2}, {@link PasswordEncoderTypes#BCRYPT}, {@link PasswordEncoderTypes#GLIBC_CRYPT} password encoders.
# cas.monitor.endpoints.jdbc.password-encoder.secret=

# Strength or number of iterations to use for password hashing.
# cas.monitor.endpoints.jdbc.password-encoder.strength=16

# The default auto-commit behavior of connections in the pool.
# cas.monitor.endpoints.jdbc.autocommit=false

# A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
# cas.monitor.endpoints.jdbc.batch-size=100

# Attempts to do a JNDI data source look up for the data source name specified.
# cas.monitor.endpoints.jdbc.data-source-name=

# Hibernate feature to automatically validate and exports DDL to the schema.
# cas.monitor.endpoints.jdbc.ddl-auto=update

# Qualifies unqualified table names with the given catalog in generated SQL.
# cas.monitor.endpoints.jdbc.default-catalog=

# Qualify unqualified table names with the given schema/tablespace in generated SQL.
# cas.monitor.endpoints.jdbc.default-schema=

# The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.
# cas.monitor.endpoints.jdbc.dialect=org.hibernate.dialect.HSQLDialect

# Set the pool initialization failure timeout.
# cas.monitor.endpoints.jdbc.fail-fast-timeout=1

# Used to specify number of rows to be fetched in a select query.
# cas.monitor.endpoints.jdbc.fetch-size=100

# Allow hibernate to generate query statistics.
# cas.monitor.endpoints.jdbc.generate-statistics=false

# The SQL query to be executed to test the validity of connections.
# cas.monitor.endpoints.jdbc.health-query=

# Controls the maximum amount of time that a connection is allowed to sit idle in the pool.
# cas.monitor.endpoints.jdbc.idle-timeout=PT10M

# This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.
# cas.monitor.endpoints.jdbc.isolate-internal-queries=false

# Defines the isolation level for transactions.
# cas.monitor.endpoints.jdbc.isolation-level-name=ISOLATION_READ_COMMITTED

# Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
# cas.monitor.endpoints.jdbc.leak-threshold=PT6S

# Fully-qualified name of the class that can control the physical naming strategy of hibernate.
# cas.monitor.endpoints.jdbc.physical-naming-strategy-class-name=org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy

# Defines the propagation behavior for transactions.
# cas.monitor.endpoints.jdbc.propagation-behavior-name=PROPAGATION_REQUIRED

# Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.
# cas.monitor.endpoints.jdbc.properties=

# Query to execute in order to authenticate users via JDBC.
# cas.monitor.endpoints.jdbc.query=

# Configures the Connections to be added to the pool as read-only Connections.
# cas.monitor.endpoints.jdbc.read-only=false

# Prefix to add to the role.
# cas.monitor.endpoints.jdbc.role-prefix=

# This property controls the keepalive interval for a connection in the pool.
# cas.monitor.endpoints.jdbc.pool.keep-alive-time=0

# Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.
# cas.monitor.endpoints.jdbc.pool.max-size=18

# Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
# cas.monitor.endpoints.jdbc.pool.max-wait=PT2S

# This property controls the maximum lifetime of a connection in the pool.
# cas.monitor.endpoints.jdbc.pool.maximum-lifetime=PT10M

# Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.
# cas.monitor.endpoints.jdbc.pool.min-size=6

# Set the name of the connection pool.
# cas.monitor.endpoints.jdbc.pool.name=

# Whether or not pool suspension is allowed.
# cas.monitor.endpoints.jdbc.pool.suspension=false

# The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
# cas.monitor.endpoints.jdbc.pool.timeout-millis=1000

Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.

cas.jdbc.case-insensitive=false

When choosing physical table names, determine whether names should be considered case-insensitive.

_{How can I configure this property?}

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

Note

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

cas.jdbc.case-insensitive=...

CAS properties can be specified using the YAML syntax:

cas: 
  jdbc: 
    case-insensitive: "..."

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.jdbc.case-insensitive="..." -jar build/libs/cas.war

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

export CAS_JDBC_CASE_INSENSITIVE="..."

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.jdbc.case-insensitive="..."

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.jdbc.gen-ddl=true

Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables.

_{How can I configure this property?}

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

Note

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

cas.jdbc.gen-ddl=true

CAS properties can be specified using the YAML syntax:

cas: 
  jdbc: 
    gen-ddl: "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.jdbc.gen-ddl="true" -jar build/libs/cas.war

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

export CAS_JDBC_GEN_DDL="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.jdbc.gen-ddl="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.jdbc.physical-table-names=

Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default.

_{How can I configure this property?}

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

Note

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

cas.jdbc.physical-table-names=...

CAS properties can be specified using the YAML syntax:

cas: 
  jdbc: 
    physical-table-names: "..."

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.jdbc.physical-table-names="..." -jar build/libs/cas.war

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

export CAS_JDBC_PHYSICAL_TABLE_NAMES="..."

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.jdbc.physical-table-names="..."

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.jdbc.show-sql=false

Whether SQL queries should be displayed in the console/logs.

_{How can I configure this property?}

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

Note

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

cas.jdbc.show-sql=...

CAS properties can be specified using the YAML syntax:

cas: 
  jdbc: 
    show-sql: "..."

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.jdbc.show-sql="..." -jar build/libs/cas.war

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

export CAS_JDBC_SHOW_SQL="..."

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.jdbc.show-sql="..."

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.monitor.endpoints.jdbc.password-encoder.encoding-algorithm=

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.encoding-algorithm=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          encoding-algorithm: "..."

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.monitor.endpoints.jdbc.password-encoder.encoding-algorithm="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_ENCODING_ALGORITHM="..."

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.monitor.endpoints.jdbc.password-encoder.encoding-algorithm="..."

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.monitor.endpoints.jdbc.password-encoder.type=NONE

The following types may be used:

NONE: No password encoding (i.e. plain-text) takes place.
DEFAULT: Use the DefaultPasswordEncoder of CAS. For message-digest algorithms via character-encoding and encoding-algorithm.
BCRYPT: Use the BCryptPasswordEncoder based on the strength provided and an optional secret.
SCRYPT: Use the SCryptPasswordEncoder.
PBKDF2: Use the Pbkdf2PasswordEncoder based on the strength provided and an optional secret.
STANDARD: Use the StandardPasswordEncoder based on the secret provided.
SSHA: Use the LdapShaPasswordEncoder supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA} or {SSHA} prepended to the encoded hash.
GLIBC_CRYPT: Use the GlibcCryptPasswordEncoder based on the encoding-algorithm, strength provided and an optional secret.
org.example.MyEncoder: An implementation of PasswordEncoder of your own choosing.
file:///path/to/script.groovy: Path to a Groovy script charged with handling password encoding operations.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.type=NONE

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          type: "NONE"

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.monitor.endpoints.jdbc.password-encoder.type="NONE" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_TYPE="NONE"

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.monitor.endpoints.jdbc.password-encoder.type="NONE"

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.monitor.endpoints.jdbc.password-encoder.character-encoding=UTF-8

The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is DEFAULT.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.character-encoding=UTF-8

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          character-encoding: "UTF-8"

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.monitor.endpoints.jdbc.password-encoder.character-encoding="UTF-8" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_CHARACTER_ENCODING="UTF-8"

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.monitor.endpoints.jdbc.password-encoder.character-encoding="UTF-8"

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.monitor.endpoints.jdbc.password-encoder.hash-length=16

When used by PasswordEncoderTypes#ARGON2, it indicates the hash strength/length.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.hash-length=16

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          hash-length: "16"

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.monitor.endpoints.jdbc.password-encoder.hash-length="16" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_HASH_LENGTH="16"

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.monitor.endpoints.jdbc.password-encoder.hash-length="16"

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.monitor.endpoints.jdbc.password-encoder.iterations=310000

When used by PasswordEncoderTypes#PBKDF2, it indicates the required number of iterations.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.iterations=310000

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          iterations: "310000"

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.monitor.endpoints.jdbc.password-encoder.iterations="310000" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_ITERATIONS="310000"

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.monitor.endpoints.jdbc.password-encoder.iterations="310000"

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.monitor.endpoints.jdbc.password-encoder.secret=

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.secret=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          secret: "..."

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.monitor.endpoints.jdbc.password-encoder.secret="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_SECRET="..."

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.monitor.endpoints.jdbc.password-encoder.secret="..."

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.monitor.endpoints.jdbc.password-encoder.strength=16

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jdbc.password-encoder.strength=16

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        password-encoder: 
          strength: "16"

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.monitor.endpoints.jdbc.password-encoder.strength="16" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JDBC_PASSWORD_ENCODER_STRENGTH="16"

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.monitor.endpoints.jdbc.password-encoder.strength="16"

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.

If you need to design your own password encoding scheme where the type is specified as a fully qualified Java class name, the structure of the class would be similar to the following:

package org.example.cas;

import org.springframework.security.crypto.codec.*;
import org.springframework.security.crypto.password.*;

public class MyEncoder extends AbstractPasswordEncoder {
    @Override
    protected byte[] encode(CharSequence rawPassword, byte[] salt) {
        return ...
    }
}

If you need to design your own password encoding scheme where the type is specified as a path to a Groovy script, the structure of the script would be similar to the following:

import java.util.*

byte[] run(final Object... args) {
    def (rawPassword,generatedSalt,logger,applicationContext) = args
    logger.debug("Encoding password...")
    return ...
}

Boolean matches(final Object... args) {
    def (rawPassword,encodedPassword,logger,applicationContext) = args
    logger.debug("Does match or not ?");
    return ...

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

cas.monitor.endpoints.ldap.base-dn=

Base DN to use. There may be scenarios where different parts of a single LDAP tree could be considered as base-dns. Rather than duplicating the LDAP configuration block for each individual base-dn, each entry can be specified and joined together using a special delimiter character. The user DN is retrieved using the combination of all base-dn and DN resolvers in the order defined. DN resolution should fail if multiple DNs are found. Otherwise the first DN found is returned. Usual syntax is: subtreeA,dc=example,dc=net|subtreeC,dc=example,dc=net.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.base-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        base-dn: "..."

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.monitor.endpoints.ldap.base-dn="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_BASE_DN="..."

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.monitor.endpoints.ldap.base-dn="..."

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.monitor.endpoints.ldap.bind-credential=

The bind credential to use when connecting to LDAP.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.bind-credential=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        bind-credential: "..."

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.monitor.endpoints.ldap.bind-credential="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_BIND_CREDENTIAL="..."

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.monitor.endpoints.ldap.bind-credential="..."

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.monitor.endpoints.ldap.bind-dn=

The bind DN to use when connecting to LDAP. LDAP connection configuration injected into the LDAP connection pool can be initialized with the following parameters:

bindDn/bindCredential provided - Use the provided credentials to bind when initializing connections.
bindDn/bindCredential set to * - Use a fast-bind strategy to initialize the pool.
bindDn/bindCredential set to blank - Skip connection initializing; perform operations anonymously.
SASL mechanism provided - Use the given SASL mechanism to bind when initializing connections.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.bind-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        bind-dn: "..."

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.monitor.endpoints.ldap.bind-dn="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_BIND_DN="..."

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.monitor.endpoints.ldap.bind-dn="..."

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.monitor.endpoints.ldap.ldap-url=

The LDAP url to the server. More than one may be specified, separated by space and/or comma.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.ldap-url=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        ldap-url: "..."

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.monitor.endpoints.ldap.ldap-url="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_LDAP_URL="..."

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.monitor.endpoints.ldap.ldap-url="..."

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.monitor.endpoints.ldap.search-filter=

User filter to use for searching. Syntax is cn={user} or cn={0}.

You may also provide an external groovy script in the syntax of file:/path/to/GroovyScript.groovy to fully build the final filter template dynamically.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-filter=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-filter: "..."

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.monitor.endpoints.ldap.search-filter="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_FILTER="..."

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.monitor.endpoints.ldap.search-filter="..."

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.monitor.endpoints.ldap.type=AUTHENTICATED

The authentication type.

AD - Users authenticate with sAMAccountName.
AUTHENTICATED - Manager bind/search type of authentication. If {} principalAttributePassword} is empty then a user simple bind is done to validate credentials. Otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.</li>
ANONYMOUS: Similar semantics as AUTHENTICATED except no bindDn and bindCredential may be specified to initialize the connection. If principalAttributePassword is empty then a user simple bind is done to validate credentials. Otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.

 DIRECT: Direct Bind - Compute user DN from format string and perform simple bind. This is relevant when no search is required to compute the DN needed for a bind operation. Use cases for this type are: 1) All users are under a single branch in the directory, e.g. ou=Users,dc=example,dc=org. 2) The username provided on the CAS login form is part of the DN, e.g. uid=%s,ou=Users,dc=example,dc=org. </ul>
Available values are as follows:


AD: Active Directory.

AUTHENTICATED: Authenticated Search.

DIRECT: Direct Bind.

ANONYMOUS: Anonymous Search.

                    </p>
 org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

                    _{How can I configure this property?}
                    
                    

                        
                            
                                
                                    CAS Property: cas.monitor.endpoints.ldap.type

                                    
                                
                                
                                    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.
                                    
                                    
                                    
                                        
                                            Java Property
                                        
                                        
                                            YAML Property
                                        
                                        
                                            System Property
                                        
                                        
                                            Environment Variable
                                        
                                        
                                            Commandline Argument
                                        
                                    
                                    
                                        
                                        
                                            CAS properties can be specified using the Java configuration property syntax in any and all
                                            .properties files:
                                            

1

cas.monitor.endpoints.ldap.type=AUTHENTICATED




                                            
                                            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:

1

cas: 
  monitor: 
    endpoints: 
      ldap: 
        type: "AUTHENTICATED"



                                            

                                            
                                            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:
                                            

1

java -Dcas.monitor.endpoints.ldap.type="AUTHENTICATED" -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:
                                            


1
2
3

export CAS_MONITOR_ENDPOINTS_LDAP_TYPE="AUTHENTICATED"

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:
                                            

1

java -jar build/libs/cas.war --cas.monitor.endpoints.ldap.type="AUTHENTICATED"




                                            
                                            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.
                                        
                                    
                                
                            
                        
                    
                    
        </div></td>
</tr>

cas.monitor.endpoints.ldap.allow-multiple-dns=false

Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.allow-multiple-dns=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        allow-multiple-dns: "..."

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.monitor.endpoints.ldap.allow-multiple-dns="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_ALLOW_MULTIPLE_DNS="..."

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.monitor.endpoints.ldap.allow-multiple-dns="..."

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.monitor.endpoints.ldap.allow-multiple-entries=false

Set if multiple Entries are allowed.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.allow-multiple-entries=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        allow-multiple-entries: "..."

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.monitor.endpoints.ldap.allow-multiple-entries="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_ALLOW_MULTIPLE_ENTRIES="..."

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.monitor.endpoints.ldap.allow-multiple-entries="..."

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.monitor.endpoints.ldap.binary-attributes=

Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.binary-attributes=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        binary-attributes: "..."

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.monitor.endpoints.ldap.binary-attributes="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_BINARY_ATTRIBUTES="..."

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.monitor.endpoints.ldap.binary-attributes="..."

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.monitor.endpoints.ldap.block-wait-time=PT3S

The length of time the pool will block. By default the pool will block indefinitely and there is no guarantee that waiting threads will be serviced in the order in which they made their request. This option should be used with a blocking connection pool when you need to control the exact number of connections that can be created

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

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.block-wait-time=PT3S

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        block-wait-time: "PT3S"

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.monitor.endpoints.ldap.block-wait-time="PT3S" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_BLOCK_WAIT_TIME="PT3S"

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.monitor.endpoints.ldap.block-wait-time="PT3S"

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.monitor.endpoints.ldap.connect-timeout=PT5S

Sets the maximum amount of time that connects will block.

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

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.connect-timeout=PT5S

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        connect-timeout: "PT5S"

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.monitor.endpoints.ldap.connect-timeout="PT5S" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_CONNECT_TIMEOUT="PT5S"

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.monitor.endpoints.ldap.connect-timeout="PT5S"

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.monitor.endpoints.ldap.connection-strategy=

If multiple URLs are provided as the ldapURL this describes how each URL will be processed.

ACTIVE_PASSIVE First LDAP will be used for every request unless it fails and then the next shall be used.
ROUND_ROBIN For each new connection the next url in the list will be used.
RANDOM For each new connection a random LDAP url will be selected.
DNS_SRV LDAP urls based on DNS SRV records of the configured/given LDAP url will be used.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.connection-strategy=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        connection-strategy: "..."

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.monitor.endpoints.ldap.connection-strategy="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_CONNECTION_STRATEGY="..."

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.monitor.endpoints.ldap.connection-strategy="..."

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.monitor.endpoints.ldap.deref-aliases=

Define how aliases are de-referenced. Accepted values are:

NEVER
SEARCHING: dereference when searching the entries beneath the starting point but not when searching for the starting entry.
FINDING: dereference when searching for the starting entry but not when searching the entries beneath the starting point.
ALWAYS: dereference when searching for the starting entry and when searching the entries beneath the starting point.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.deref-aliases=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        deref-aliases: "..."

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.monitor.endpoints.ldap.deref-aliases="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_DEREF_ALIASES="..."

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.monitor.endpoints.ldap.deref-aliases="..."

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.monitor.endpoints.ldap.disable-pooling=false

Whether to use a pooled connection factory in components.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.disable-pooling=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        disable-pooling: "..."

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.monitor.endpoints.ldap.disable-pooling="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_DISABLE_POOLING="..."

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.monitor.endpoints.ldap.disable-pooling="..."

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.monitor.endpoints.ldap.dn-format=

Specify the dn format accepted by the AD authenticator, etc. Example format might be uid=%s,ou=people,dc=example,dc=org.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.dn-format=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        dn-format: "..."

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.monitor.endpoints.ldap.dn-format="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_DN_FORMAT="..."

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.monitor.endpoints.ldap.dn-format="..."

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.monitor.endpoints.ldap.enhance-with-entry-resolver=true

Whether specific search entry resolvers need to be set on the authenticator, or the default should be used.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.enhance-with-entry-resolver=true

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        enhance-with-entry-resolver: "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.monitor.endpoints.ldap.enhance-with-entry-resolver="true" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_ENHANCE_WITH_ENTRY_RESOLVER="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.monitor.endpoints.ldap.enhance-with-entry-resolver="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.monitor.endpoints.ldap.fail-fast=true

Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.fail-fast=true

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        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.monitor.endpoints.ldap.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_MONITOR_ENDPOINTS_LDAP_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.monitor.endpoints.ldap.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.monitor.endpoints.ldap.follow-referrals=true

Set if search referrals should be followed.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.follow-referrals=true

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        follow-referrals: "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.monitor.endpoints.ldap.follow-referrals="true" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_FOLLOW_REFERRALS="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.monitor.endpoints.ldap.follow-referrals="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.monitor.endpoints.ldap.hostname-verifier=DEFAULT

Hostname verification options. Available values are as follows:

DEFAULT: Default option, forcing verification.
ANY: Skip hostname verification and allow all.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.hostname-verifier=DEFAULT

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        hostname-verifier: "DEFAULT"

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.monitor.endpoints.ldap.hostname-verifier="DEFAULT" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_HOSTNAME_VERIFIER="DEFAULT"

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.monitor.endpoints.ldap.hostname-verifier="DEFAULT"

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.monitor.endpoints.ldap.idle-time=PT10M

Removes connections from the pool based on how long they have been idle in the available queue. Prunes connections that have been idle for more than the indicated amount.

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

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.idle-time=PT10M

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        idle-time: "PT10M"

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.monitor.endpoints.ldap.idle-time="PT10M" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_IDLE_TIME="PT10M"

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.monitor.endpoints.ldap.idle-time="PT10M"

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.monitor.endpoints.ldap.keystore=

Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.keystore=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        keystore: "..."

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.monitor.endpoints.ldap.keystore="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_KEYSTORE="..."

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.monitor.endpoints.ldap.keystore="..."

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.monitor.endpoints.ldap.keystore-password=

Keystore password.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.keystore-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        keystore-password: "..."

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.monitor.endpoints.ldap.keystore-password="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_KEYSTORE_PASSWORD="..."

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.monitor.endpoints.ldap.keystore-password="..."

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.monitor.endpoints.ldap.keystore-type=

The type of keystore. PKCS12 or JKS. If left blank, defaults to the default keystore type indicated by the underlying Java platform.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.keystore-type=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        keystore-type: "..."

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.monitor.endpoints.ldap.keystore-type="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_KEYSTORE_TYPE="..."

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.monitor.endpoints.ldap.keystore-type="..."

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.monitor.endpoints.ldap.max-pool-size=10

Maximum LDAP connection pool size which the pool can use to grow.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.max-pool-size=10

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        max-pool-size: "10"

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.monitor.endpoints.ldap.max-pool-size="10" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_MAX_POOL_SIZE="10"

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.monitor.endpoints.ldap.max-pool-size="10"

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.monitor.endpoints.ldap.min-pool-size=3

Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.min-pool-size=3

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        min-pool-size: "3"

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.monitor.endpoints.ldap.min-pool-size="3" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_MIN_POOL_SIZE="3"

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.monitor.endpoints.ldap.min-pool-size="3"

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.monitor.endpoints.ldap.name=

Name of the LDAP handler.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.name=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        name: "..."

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.monitor.endpoints.ldap.name="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_NAME="..."

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.monitor.endpoints.ldap.name="..."

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.monitor.endpoints.ldap.page-size=0

Request that the server return results in batches of a specific size. See RFC 2696. This control is often used to work around server result size limits. A negative/zero value disables paged requests.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.page-size=0

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        page-size: "0"

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.monitor.endpoints.ldap.page-size="0" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_PAGE_SIZE="0"

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.monitor.endpoints.ldap.page-size="0"

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.monitor.endpoints.ldap.pool-passivator=BIND

You may receive unexpected LDAP failures, when CAS is configured to authenticate using DIRECT or AUTHENTICATED types and LDAP is locked down to not allow anonymous binds/searches. Every second attempt with a given LDAP connection from the pool would fail if it was on the same connection as a failed login attempt, and the regular connection validator would similarly fail. When a connection is returned back to a pool, it still may contain the principal and credentials from the previous attempt. Before the next bind attempt using that connection, the validator tries to validate the connection again but fails because it’s no longer trying with the configured bind credentials but with whatever user DN was used in the previous step. Given the validation failure, the connection is closed and CAS would deny access by default. Passivators attempt to reconnect to LDAP with the configured bind credentials, effectively resetting the connection to what it should be after each bind request. Furthermore if you are seeing errors in the logs that resemble a 'Operation exception encountered, reopening connection' type of message, this usually is an indication that the connection pool’s validation timeout established and created by CAS is greater than the timeout configured in the LDAP server, or more likely, in the load balancer in front of the LDAP servers. You can adjust the LDAP server session’s timeout for connections, or you can teach CAS to use a validity period that is equal or less than the LDAP server session’s timeout. Accepted values are:

NONE: No passivation takes place.
BIND: The default behavior which passivates a connection by performing a bind operation on it. This option requires the availability of bind credentials when establishing connections to LDAP.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.pool-passivator=BIND

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        pool-passivator: "BIND"

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.monitor.endpoints.ldap.pool-passivator="BIND" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_POOL_PASSIVATOR="BIND"

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.monitor.endpoints.ldap.pool-passivator="BIND"

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.monitor.endpoints.ldap.principal-attribute-password=

If principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.

For the anonymous authentication type, if principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.principal-attribute-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        principal-attribute-password: "..."

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.monitor.endpoints.ldap.principal-attribute-password="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_PRINCIPAL_ATTRIBUTE_PASSWORD="..."

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.monitor.endpoints.ldap.principal-attribute-password="..."

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.monitor.endpoints.ldap.prune-period=PT2H

Removes connections from the pool based on how long they have been idle in the available queue. Run the pruning process at the indicated interval.

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

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.prune-period=PT2H

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        prune-period: "PT2H"

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.monitor.endpoints.ldap.prune-period="PT2H" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_PRUNE_PERIOD="PT2H"

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.monitor.endpoints.ldap.prune-period="PT2H"

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.monitor.endpoints.ldap.resolve-from-attribute=

If this attribute is set, the value found in the first attribute value will be used in place of the DN.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.resolve-from-attribute=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        resolve-from-attribute: "..."

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.monitor.endpoints.ldap.resolve-from-attribute="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_RESOLVE_FROM_ATTRIBUTE="..."

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.monitor.endpoints.ldap.resolve-from-attribute="..."

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.monitor.endpoints.ldap.response-timeout=PT5S

Duration of time to wait for responses.

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

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.response-timeout=PT5S

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        response-timeout: "PT5S"

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.monitor.endpoints.ldap.response-timeout="PT5S" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_RESPONSE_TIMEOUT="PT5S"

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.monitor.endpoints.ldap.response-timeout="PT5S"

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.monitor.endpoints.ldap.sasl-authorization-id=

SASL authorization id.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.sasl-authorization-id=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        sasl-authorization-id: "..."

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.monitor.endpoints.ldap.sasl-authorization-id="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SASL_AUTHORIZATION_ID="..."

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.monitor.endpoints.ldap.sasl-authorization-id="..."

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.monitor.endpoints.ldap.sasl-mechanism=

The SASL mechanism.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.sasl-mechanism=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        sasl-mechanism: "..."

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.monitor.endpoints.ldap.sasl-mechanism="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SASL_MECHANISM="..."

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.monitor.endpoints.ldap.sasl-mechanism="..."

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.monitor.endpoints.ldap.sasl-mutual-auth=

SASL mutual auth is enabled?

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.sasl-mutual-auth=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        sasl-mutual-auth: "..."

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.monitor.endpoints.ldap.sasl-mutual-auth="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SASL_MUTUAL_AUTH="..."

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.monitor.endpoints.ldap.sasl-mutual-auth="..."

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.monitor.endpoints.ldap.sasl-quality-of-protection=

SASL quality of protected.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.sasl-quality-of-protection=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        sasl-quality-of-protection: "..."

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.monitor.endpoints.ldap.sasl-quality-of-protection="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SASL_QUALITY_OF_PROTECTION="..."

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.monitor.endpoints.ldap.sasl-quality-of-protection="..."

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.monitor.endpoints.ldap.sasl-realm=

The SASL realm.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.sasl-realm=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        sasl-realm: "..."

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.monitor.endpoints.ldap.sasl-realm="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SASL_REALM="..."

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.monitor.endpoints.ldap.sasl-realm="..."

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.monitor.endpoints.ldap.sasl-security-strength=

SASL security strength.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.sasl-security-strength=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        sasl-security-strength: "..."

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.monitor.endpoints.ldap.sasl-security-strength="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SASL_SECURITY_STRENGTH="..."

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.monitor.endpoints.ldap.sasl-security-strength="..."

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.monitor.endpoints.ldap.search-entry-handlers=

Search handlers.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers: "..."

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.monitor.endpoints.ldap.search-entry-handlers="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS="..."

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.monitor.endpoints.ldap.search-entry-handlers="..."

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.monitor.endpoints.ldap.subtree-search=true

Whether subtree searching is allowed.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.subtree-search=true

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        subtree-search: "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.monitor.endpoints.ldap.subtree-search="true" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SUBTREE_SEARCH="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.monitor.endpoints.ldap.subtree-search="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.monitor.endpoints.ldap.trust-certificates=

Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.trust-certificates=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        trust-certificates: "..."

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.monitor.endpoints.ldap.trust-certificates="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_TRUST_CERTIFICATES="..."

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.monitor.endpoints.ldap.trust-certificates="..."

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.monitor.endpoints.ldap.trust-manager=

Trust Manager options. Trust managers are responsible for managing the trust material that is used when making LDAP trust decisions, and for deciding whether credentials presented by a peer should be accepted. Accepted values are: *

DEFAULT: Enable and force the default JVM trust managers.
ANY: Trust any client or server.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.trust-manager=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        trust-manager: "..."

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.monitor.endpoints.ldap.trust-manager="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_TRUST_MANAGER="..."

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.monitor.endpoints.ldap.trust-manager="..."

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.monitor.endpoints.ldap.trust-store=

Path to the keystore used to determine which certificates or certificate authorities should be trusted. Used when connecting to an LDAP server via LDAPS or startTLS connection. If left blank, the default truststore for the Java runtime is used.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.trust-store=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        trust-store: "..."

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.monitor.endpoints.ldap.trust-store="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_TRUST_STORE="..."

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.monitor.endpoints.ldap.trust-store="..."

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.monitor.endpoints.ldap.trust-store-password=

Password needed to open the truststore.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.trust-store-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        trust-store-password: "..."

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.monitor.endpoints.ldap.trust-store-password="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_TRUST_STORE_PASSWORD="..."

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.monitor.endpoints.ldap.trust-store-password="..."

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.monitor.endpoints.ldap.trust-store-type=

The type of trust keystore that determines which certificates or certificate authorities are trusted. Types depend on underlying java platform, typically PKCS12 or JKS. If left blank, defaults to the default keystore type indicated by the underlying Java platform.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.trust-store-type=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        trust-store-type: "..."

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.monitor.endpoints.ldap.trust-store-type="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_TRUST_STORE_TYPE="..."

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.monitor.endpoints.ldap.trust-store-type="..."

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.monitor.endpoints.ldap.use-start-tls=false

Whether TLS should be used and enabled when establishing the connection.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.use-start-tls=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        use-start-tls: "..."

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.monitor.endpoints.ldap.use-start-tls="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_USE_START_TLS="..."

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.monitor.endpoints.ldap.use-start-tls="..."

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.monitor.endpoints.ldap.validate-on-checkout=true

Whether connections should be validated when loaned out from the pool.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validate-on-checkout=true

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validate-on-checkout: "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.monitor.endpoints.ldap.validate-on-checkout="true" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATE_ON_CHECKOUT="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.monitor.endpoints.ldap.validate-on-checkout="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.monitor.endpoints.ldap.validate-period=PT5M

Period at which pool should be validated.

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

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validate-period=PT5M

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validate-period: "PT5M"

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.monitor.endpoints.ldap.validate-period="PT5M" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATE_PERIOD="PT5M"

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.monitor.endpoints.ldap.validate-period="PT5M"

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.monitor.endpoints.ldap.validate-periodically=true

Whether connections should be validated periodically when the pool is idle.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validate-periodically=true

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validate-periodically: "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.monitor.endpoints.ldap.validate-periodically="true" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATE_PERIODICALLY="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.monitor.endpoints.ldap.validate-periodically="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.monitor.endpoints.ldap.validate-timeout=PT5S

Period at which validation operations may time out.

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

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validate-timeout=PT5S

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validate-timeout: "PT5S"

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.monitor.endpoints.ldap.validate-timeout="PT5S" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATE_TIMEOUT="PT5S"

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.monitor.endpoints.ldap.validate-timeout="PT5S"

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.monitor.endpoints.ldap.ldap-authz.allow-multiple-results=false

Indicate whether the LDAP search query is allowed to return multiple entries.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.ldap-authz.allow-multiple-results=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        ldap-authz: 
          allow-multiple-results: "..."

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.monitor.endpoints.ldap.ldap-authz.allow-multiple-results="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_LDAP_AUTHZ_ALLOW_MULTIPLE_RESULTS="..."

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.monitor.endpoints.ldap.ldap-authz.allow-multiple-results="..."

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.monitor.endpoints.ldap.ldap-authz.base-dn=

Base DN to start the search.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.ldap-authz.base-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        ldap-authz: 
          base-dn: "..."

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.monitor.endpoints.ldap.ldap-authz.base-dn="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_LDAP_AUTHZ_BASE_DN="..."

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.monitor.endpoints.ldap.ldap-authz.base-dn="..."

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.monitor.endpoints.ldap.ldap-authz.group-attribute=

Attribute expected to be found on the entry resulting from the group search whose value is going to be used to construct roles. The final value is always prefixed with #groupPrefix. This is useful in scenarios where you wish to grant access to a resource to all users who a member of a given group.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.ldap-authz.group-attribute=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        ldap-authz: 
          group-attribute: "..."

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.monitor.endpoints.ldap.ldap-authz.group-attribute="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_LDAP_AUTHZ_GROUP_ATTRIBUTE="..."

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.monitor.endpoints.ldap.ldap-authz.group-attribute="..."

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.monitor.endpoints.ldap.ldap-authz.group-base-dn=

Base DN to start the search looking for groups.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.ldap-authz.group-base-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        ldap-authz: 
          group-base-dn: "..."

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.monitor.endpoints.ldap.ldap-authz.group-base-dn="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_LDAP_AUTHZ_GROUP_BASE_DN="..."

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.monitor.endpoints.ldap.ldap-authz.group-base-dn="..."

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.monitor.endpoints.ldap.ldap-authz.group-filter=

Search filter to begin looking for groups.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.ldap-authz.group-filter=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        ldap-authz: 
          group-filter: "..."

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.monitor.endpoints.ldap.ldap-authz.group-filter="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_LDAP_AUTHZ_GROUP_FILTER="..."

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.monitor.endpoints.ldap.ldap-authz.group-filter="..."

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.monitor.endpoints.ldap.ldap-authz.group-prefix=

A prefix that is prepended to the group attribute value to construct an authorized role.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.ldap-authz.group-prefix=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        ldap-authz: 
          group-prefix: "..."

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.monitor.endpoints.ldap.ldap-authz.group-prefix="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_LDAP_AUTHZ_GROUP_PREFIX="..."

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.monitor.endpoints.ldap.ldap-authz.group-prefix="..."

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.monitor.endpoints.ldap.ldap-authz.role-attribute=uugid

Attribute expected to be found on the entry whose value is going to be used to construct roles. The final value is always prefixed with #rolePrefix. This is useful in scenarios where you wish to grant access to a resource to all users who carry a special attribute.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.ldap-authz.role-attribute=uugid

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        ldap-authz: 
          role-attribute: "uugid"

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.monitor.endpoints.ldap.ldap-authz.role-attribute="uugid" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_LDAP_AUTHZ_ROLE_ATTRIBUTE="uugid"

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.monitor.endpoints.ldap.ldap-authz.role-attribute="uugid"

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.monitor.endpoints.ldap.ldap-authz.role-prefix=ROLE_

Prefix for the role.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.ldap-authz.role-prefix=ROLE_

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        ldap-authz: 
          role-prefix: "ROLE_"

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.monitor.endpoints.ldap.ldap-authz.role-prefix="ROLE_" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_LDAP_AUTHZ_ROLE_PREFIX="ROLE_"

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.monitor.endpoints.ldap.ldap-authz.role-prefix="ROLE_"

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.monitor.endpoints.ldap.ldap-authz.search-filter=

LDAP search filter to locate accounts.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.ldap-authz.search-filter=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        ldap-authz: 
          search-filter: "..."

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.monitor.endpoints.ldap.ldap-authz.search-filter="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_LDAP_AUTHZ_SEARCH_FILTER="..."

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.monitor.endpoints.ldap.ldap-authz.search-filter="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=

The Attribute name case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          case-change: 
            attribute-name-case-change: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_ATTRIBUTE_NAME_CASE_CHANGE="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names=

The Attribute names.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          case-change: 
            attribute-names: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_ATTRIBUTE_NAMES="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=

The Attribute value case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          case-change: 
            attribute-value-case-change: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_ATTRIBUTE_VALUE_CASE_CHANGE="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change=

The Dn case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          case-change: 
            dn-case-change: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_DN_CASE_CHANGE="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=

The Add if exists.

org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          dn-attribute: 
            add-if-exists: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_DN_ATTRIBUTE_ADD_IF_EXISTS="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN

The Dn attribute name.

org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          dn-attribute: 
            dn-attribute-name: "entryDN"

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.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name="entryDN" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_DN_ATTRIBUTE_DN_ATTRIBUTE_NAME="entryDN"

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.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name="entryDN"

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.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names=

The Attribute names.

org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          merge-attribute: 
            attribute-names: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_MERGE_ATTRIBUTE_ATTRIBUTE_NAMES="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=

The Merge attribute name.

org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          merge-attribute: 
            merge-attribute-name: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_MERGE_ATTRIBUTE_MERGE_ATTRIBUTE_NAME="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn=

The Base dn.

org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          primary-group-id: 
            base-dn: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_PRIMARY_GROUP_ID_BASE_DN="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

The Group filter.

org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          primary-group-id: 
            group-filter: "(&(objectClass=group)(objectSid={0}))"

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.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter="(&(objectClass=group)(objectSid={0}))" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_PRIMARY_GROUP_ID_GROUP_FILTER="(&(objectClass=group)(objectSid={0}))"

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.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter="(&(objectClass=group)(objectSid={0}))"

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.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes=

The Merge attributes.

org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          recursive: 
            merge-attributes: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_RECURSIVE_MERGE_ATTRIBUTES="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute=

The Search attribute.

org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          recursive: 
            search-attribute: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_RECURSIVE_SEARCH_ATTRIBUTE="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].search-referral.limit=10

The default referral limit.

org.apereo.cas.configuration.model.support.ldap.FollowReferralSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].search-referral.limit=10

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          search-referral: 
            limit: "10"

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.monitor.endpoints.ldap.search-entry-handlers[0].search-referral.limit="10" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_SEARCH_REFERRAL_LIMIT="10"

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.monitor.endpoints.ldap.search-entry-handlers[0].search-referral.limit="10"

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.monitor.endpoints.ldap.search-entry-handlers[0].search-result.limit=10

The default referral limit.

org.apereo.cas.configuration.model.support.ldap.FollowResultSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].search-result.limit=10

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          search-result: 
            limit: "10"

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.monitor.endpoints.ldap.search-entry-handlers[0].search-result.limit="10" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_SEARCH_RESULT_LIMIT="10"

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.monitor.endpoints.ldap.search-entry-handlers[0].search-result.limit="10"

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.monitor.endpoints.ldap.search-entry-handlers[0].type=

The type of search entry handler to choose. Available values are as follows:

FOLLOW_SEARCH_REFERRAL: Provides handling of an ldap referral for search operations.
FOLLOW_SEARCH_RESULT_REFERENCE: Provides handling of an ldap continuation reference for search operations.
ACTIVE_DIRECTORY: Process the entry results fetched from active directory and check for account status controls for disabled/expired accounts, etc.
OBJECT_GUID: Object guid search entry handler. Handles the objectGUID attribute fetching and conversion.
OBJECT_SID: Object sid search entry handler. Handles the objectSid attribute fetching and conversion.
CASE_CHANGE: Case change search entry handler. Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.
DN_ATTRIBUTE_ENTRY: DN attribute entry handler. Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020.
MERGE: Merge search entry handler. Merges the values of one or more attributes into a single attribute.
PRIMARY_GROUP: Primary group search handler. Constructs the primary group SID and then searches for that group and puts it's DN in the memberOf attribute of the original search entry.
RANGE_ENTRY: Range entry search handler. Rewrites attributes returned from Active Directory to include all values by performing additional searches.
RECURSIVE_ENTRY: Recursive entry search handler. This recursively searches based on a supplied attribute and merges those results into the original entry.
MERGE_ENTRIES: Merge entries handler. Merges the values of one or more attributes in all entries into a single attribute. The merged attribute may or may not already exist on the entry. If it does exist it's existing values will remain intact.

org.apereo.cas.configuration.model.support.ldap.LdapSearchEntryHandlersProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.search-entry-handlers[0].type=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        search-entry-handlers[0]: 
          type: "..."

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.monitor.endpoints.ldap.search-entry-handlers[0].type="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_SEARCH_ENTRY_HANDLERS[0]_TYPE="..."

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.monitor.endpoints.ldap.search-entry-handlers[0].type="..."

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.monitor.endpoints.ldap.validator.attribute-name=objectClass

Attribute name to use for the compare validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validator.attribute-name=objectClass

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validator: 
          attribute-name: "objectClass"

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.monitor.endpoints.ldap.validator.attribute-name="objectClass" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATOR_ATTRIBUTE_NAME="objectClass"

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.monitor.endpoints.ldap.validator.attribute-name="objectClass"

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.monitor.endpoints.ldap.validator.attribute-value=top

Attribute values to use for the compare validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validator.attribute-value=top

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validator: 
          attribute-value: "top"

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.monitor.endpoints.ldap.validator.attribute-value="top" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATOR_ATTRIBUTE_VALUE="top"

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.monitor.endpoints.ldap.validator.attribute-value="top"

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.monitor.endpoints.ldap.validator.base-dn=

Base DN to use for the search request of the search validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validator.base-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validator: 
          base-dn: "..."

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.monitor.endpoints.ldap.validator.base-dn="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATOR_BASE_DN="..."

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.monitor.endpoints.ldap.validator.base-dn="..."

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.monitor.endpoints.ldap.validator.dn=

DN to compare to use for the compare validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validator.dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validator: 
          dn: "..."

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.monitor.endpoints.ldap.validator.dn="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATOR_DN="..."

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.monitor.endpoints.ldap.validator.dn="..."

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.monitor.endpoints.ldap.validator.scope=OBJECT

Search scope to use for the search request of the search validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validator.scope=OBJECT

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validator: 
          scope: "OBJECT"

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.monitor.endpoints.ldap.validator.scope="OBJECT" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATOR_SCOPE="OBJECT"

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.monitor.endpoints.ldap.validator.scope="OBJECT"

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.monitor.endpoints.ldap.validator.search-filter=(objectClass=*)

Search filter to use for the search request of the search validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validator.search-filter=(objectClass=*)

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validator: 
          search-filter: "(objectClass=*)"

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.monitor.endpoints.ldap.validator.search-filter="(objectClass=*)" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATOR_SEARCH_FILTER="(objectClass=*)"

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.monitor.endpoints.ldap.validator.search-filter="(objectClass=*)"

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.monitor.endpoints.ldap.validator.type=search

Determine the LDAP validator type.

The following LDAP validators can be used to test connection health status:

search: Validates a connection is healthy by performing a search operation. Validation is considered successful if the search result size is greater than zero.
none: No validation takes place.
compare: Validates a connection is healthy by performing a compare operation.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.ldap.validator.type=search

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      ldap: 
        validator: 
          type: "search"

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.monitor.endpoints.ldap.validator.type="search" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_LDAP_VALIDATOR_TYPE="search"

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.monitor.endpoints.ldap.validator.type="search"

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.

# Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.
# cas.monitor.endpoints.ldap.allow-multiple-dns=false

# Set if multiple Entries are allowed.
# cas.monitor.endpoints.ldap.allow-multiple-entries=false

# Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.
# cas.monitor.endpoints.ldap.binary-attributes=

# The length of time the pool will block.
# cas.monitor.endpoints.ldap.block-wait-time=PT3S

# Sets the maximum amount of time that connects will block.
# cas.monitor.endpoints.ldap.connect-timeout=PT5S

# If multiple URLs are provided as the ldapURL this describes how each URL will be processed.
# cas.monitor.endpoints.ldap.connection-strategy=

# Define how aliases are de-referenced.
# cas.monitor.endpoints.ldap.deref-aliases=

# Whether to use a pooled connection factory in components.
# cas.monitor.endpoints.ldap.disable-pooling=false

# Specify the dn format accepted by the AD authenticator, etc.
# cas.monitor.endpoints.ldap.dn-format=

# Whether specific search entry resolvers need to be set on the authenticator, or the default should be used.
# cas.monitor.endpoints.ldap.enhance-with-entry-resolver=true

# Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.
# cas.monitor.endpoints.ldap.fail-fast=true

# Set if search referrals should be followed.
# cas.monitor.endpoints.ldap.follow-referrals=true

# Hostname verification options.
# cas.monitor.endpoints.ldap.hostname-verifier=DEFAULT

# Removes connections from the pool based on how long they have been idle in the available queue.
# cas.monitor.endpoints.ldap.idle-time=PT10M

# Path to the keystore used for SSL connections.
# cas.monitor.endpoints.ldap.keystore=

# Keystore password.
# cas.monitor.endpoints.ldap.keystore-password=

# The type of keystore.
# cas.monitor.endpoints.ldap.keystore-type=

# Maximum LDAP connection pool size which the pool can use to grow.
# cas.monitor.endpoints.ldap.max-pool-size=10

# Minimum LDAP connection pool size.
# cas.monitor.endpoints.ldap.min-pool-size=3

# Name of the LDAP handler.
# cas.monitor.endpoints.ldap.name=

# Request that the server return results in batches of a specific size.
# cas.monitor.endpoints.ldap.page-size=0

# You may receive unexpected LDAP failures, when CAS is configured to authenticate using {@code DIRECT} or {@code AUTHENTICATED} types and LDAP is locked down to not allow anonymous binds/searches.
# cas.monitor.endpoints.ldap.pool-passivator=BIND

# If principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.
# cas.monitor.endpoints.ldap.principal-attribute-password=

# Removes connections from the pool based on how long they have been idle in the available queue.
# cas.monitor.endpoints.ldap.prune-period=PT2H

# If this attribute is set, the value found in the first attribute value will be used in place of the DN.
# cas.monitor.endpoints.ldap.resolve-from-attribute=

# Duration of time to wait for responses.
# cas.monitor.endpoints.ldap.response-timeout=PT5S

# SASL authorization id.
# cas.monitor.endpoints.ldap.sasl-authorization-id=

# The SASL mechanism.
# cas.monitor.endpoints.ldap.sasl-mechanism=

# SASL mutual auth is enabled?
# cas.monitor.endpoints.ldap.sasl-mutual-auth=

# SASL quality of protected.
# cas.monitor.endpoints.ldap.sasl-quality-of-protection=

# The SASL realm.
# cas.monitor.endpoints.ldap.sasl-realm=

# SASL security strength.
# cas.monitor.endpoints.ldap.sasl-security-strength=

# Search handlers.
# cas.monitor.endpoints.ldap.search-entry-handlers=

# Whether subtree searching is allowed.
# cas.monitor.endpoints.ldap.subtree-search=true

# Path of the trust certificates to use for the SSL connection.
# cas.monitor.endpoints.ldap.trust-certificates=

# Trust Manager options.
# cas.monitor.endpoints.ldap.trust-manager=

# Path to the keystore used to determine which certificates or certificate authorities should be trusted.
# cas.monitor.endpoints.ldap.trust-store=

# Password needed to open the truststore.
# cas.monitor.endpoints.ldap.trust-store-password=

# The type of trust keystore that determines which certificates or certificate authorities are trusted.
# cas.monitor.endpoints.ldap.trust-store-type=

# Whether TLS should be used and enabled when establishing the connection.
# cas.monitor.endpoints.ldap.use-start-tls=false

# Whether connections should be validated when loaned out from the pool.
# cas.monitor.endpoints.ldap.validate-on-checkout=true

# Period at which pool should be validated.
# cas.monitor.endpoints.ldap.validate-period=PT5M

# Whether connections should be validated periodically when the pool is idle.
# cas.monitor.endpoints.ldap.validate-periodically=true

# Period at which validation operations may time out.
# cas.monitor.endpoints.ldap.validate-timeout=PT5S

# Indicate whether the LDAP search query is allowed to return multiple entries.
# cas.monitor.endpoints.ldap.ldap-authz.allow-multiple-results=false

# Base DN to start the search.
# cas.monitor.endpoints.ldap.ldap-authz.base-dn=

# Attribute expected to be found on the entry resulting from the group search whose value is going to be used to construct roles.
# cas.monitor.endpoints.ldap.ldap-authz.group-attribute=

# Base DN to start the search looking for groups.
# cas.monitor.endpoints.ldap.ldap-authz.group-base-dn=

# Search filter to begin looking for groups.
# cas.monitor.endpoints.ldap.ldap-authz.group-filter=

# A prefix that is prepended to the group attribute value to construct an authorized role.
# cas.monitor.endpoints.ldap.ldap-authz.group-prefix=

# Attribute expected to be found on the entry whose value is going to be used to construct roles.
# cas.monitor.endpoints.ldap.ldap-authz.role-attribute=uugid

# Prefix for the role.
# cas.monitor.endpoints.ldap.ldap-authz.role-prefix=ROLE_

# LDAP search filter to locate accounts.
# cas.monitor.endpoints.ldap.ldap-authz.search-filter=

# The Attribute name case change.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=

# The Attribute names.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names=

# The Attribute value case change.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=

# The Dn case change.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change=

# The Add if exists.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=

# The Dn attribute name.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN

# The Attribute names.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names=

# The Merge attribute name.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=

# The Base dn.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn=

# The Group filter.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

# The Merge attributes.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes=

# The Search attribute.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute=

# The default referral limit.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].search-referral.limit=10

# The default referral limit.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].search-result.limit=10

# The type of search entry handler to choose.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].type=

# Attribute name to use for the compare validator.
# cas.monitor.endpoints.ldap.validator.attribute-name=objectClass

# Attribute values to use for the compare validator.
# cas.monitor.endpoints.ldap.validator.attribute-value=top

# Base DN to use for the search request of the search validator.
# cas.monitor.endpoints.ldap.validator.base-dn=

# DN to compare to use for the compare validator.
# cas.monitor.endpoints.ldap.validator.dn=

# Search scope to use for the search request of the search validator.
# cas.monitor.endpoints.ldap.validator.scope=OBJECT

# Search filter to use for the search request of the search validator.
# cas.monitor.endpoints.ldap.validator.search-filter=(objectClass=*)

# Determine the LDAP validator type.
# cas.monitor.endpoints.ldap.validator.type=search

LDAP search filters can point to an external Groovy script to dynamically construct the final filter template.

The script itself may be designed as:

import org.ldaptive.*
import org.springframework.context.*

def run(Object[] args) {
    def (filter,parameters,applicationContext,logger) = args

    logger.info("Configuring LDAP filter")
    filter.setFilter("uid=something")
}

The following parameters are passed to the script:

Parameter	Description
`filter`	`FilterTemplate` to be updated by the script and used for the LDAP query.
`parameters`	Map of query parameters which may be used to construct the final filter.
`applicationContext`	Reference to the Spring `ApplicationContext` reference.
`logger`	The object responsible for issuing log messages such as `logger.info(...)`.

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

cas.monitor.endpoints.jaas.login-config=

JAAS login resource file.

org.apereo.cas.configuration.model.core.monitor.JaasSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jaas.login-config=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jaas: 
        login-config: "..."

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.monitor.endpoints.jaas.login-config="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JAAS_LOGIN_CONFIG="..."

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.monitor.endpoints.jaas.login-config="..."

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.monitor.endpoints.jaas.login-context-name=

The login context name should coincide with a given index in the login config specified. This name is used as the index to the configuration specified in the login config property.

 JAASTest { org.springframework.security.authentication.jaas.TestLoginModule required; };

In the above example, JAASTest should be set as the context name.

org.apereo.cas.configuration.model.core.monitor.JaasSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jaas.login-context-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jaas: 
        login-context-name: "..."

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.monitor.endpoints.jaas.login-context-name="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JAAS_LOGIN_CONTEXT_NAME="..."

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.monitor.endpoints.jaas.login-context-name="..."

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.monitor.endpoints.jaas.refresh-configuration-on-startup=true

If set, a call to Configuration#refresh() will be made by #configureJaas(Resource) method.

org.apereo.cas.configuration.model.core.monitor.JaasSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.jaas.refresh-configuration-on-startup=true

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jaas: 
        refresh-configuration-on-startup: "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.monitor.endpoints.jaas.refresh-configuration-on-startup="true" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JAAS_REFRESH_CONFIGURATION_ON_STARTUP="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.monitor.endpoints.jaas.refresh-configuration-on-startup="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.

DELETE /cas/actuator/gauthCredentialRepository/{username}

Delete account for the user.

Endpoint Parameters:

username

CAS, being a Spring-Boot application at heart, includes a number of endpoints to help you monitor and manage the server when it’s pushed to production. You can choose to manage and monitor the deployment using HTTP endpoints, referred to as actuators.

In essence, actuator endpoints bring production-ready features to CAS. Monitoring a running CAS instance, gathering metrics, understanding traffic or the state of our database becomes trivial with such endpoints. The main benefit of these endpoints is that we can get production grade tools without having to actually implement these features ourselves. Actuators are mainly used to expose operational information about the running application – health, metrics, etc. These are HTTP endpoints or JMX beans to enable us to interact with it.

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

Note that by default the only endpoints exposed over the web are info, status, health and configurationMetadata. Other endpoints need to be explicitly enabled and then exposed over the web in CAS settings in order to allow access.

To enable and expose an actuator endpoint:

management.endpoint.gauthCredentialRepository.enabled=true
management.endpoints.web.exposure.include=gauthCredentialRepository

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.gauthCredentialRepository.access=PERMIT

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

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.form-login-enabled=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      form-login-enabled: "..."

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.monitor.endpoints.form-login-enabled="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_FORM_LOGIN_ENABLED="..."

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.monitor.endpoints.form-login-enabled="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.access=DENY

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.endpoint.gauthCredentialRepository.access=DENY

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        gauthCredentialRepository: 
          access: "DENY"

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.monitor.endpoints.endpoint.gauthCredentialRepository.access="DENY" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_ENDPOINT_[KEY]_ACCESS="DENY"

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.monitor.endpoints.endpoint.gauthCredentialRepository.access="DENY"

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.endpoint.gauthCredentialRepository.required-authorities=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        gauthCredentialRepository: 
          required-authorities: "..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-authorities="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_ENDPOINT_[KEY]_REQUIRED_AUTHORITIES="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-authorities="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-ip-addresses=

Required IP addresses. CIDR ranges are accepted.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.endpoint.gauthCredentialRepository.required-ip-addresses=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        gauthCredentialRepository: 
          required-ip-addresses: "..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-ip-addresses="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_ENDPOINT_[KEY]_REQUIRED_IP_ADDRESSES="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-ip-addresses="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.endpoint.gauthCredentialRepository.required-roles=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        gauthCredentialRepository: 
          required-roles: "..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-roles="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_ENDPOINT_[KEY]_REQUIRED_ROLES="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-roles="..."

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.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.cache.time-to-live=0ms

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      cache: 
        time-to-live: "0ms"

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 -Dmanagement.endpoint.health.cache.time-to-live="0ms" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_CACHE_TIME_TO_LIVE="0ms"

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 --management.endpoint.health.cache.time-to-live="0ms"

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.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      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 -Dmanagement.endpoint.health.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_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 --management.endpoint.health.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.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.group=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      group: "..."

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 -Dmanagement.endpoint.health.group="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_GROUP="..."

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 --management.endpoint.health.group="..."

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.

management.endpoint.health.logging.slow-indicator-threshold=10s

Threshold after which a warning will be logged for slow health indicators.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties$Logging.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.logging.slow-indicator-threshold=10s

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      logging: 
        slow-indicator-threshold: "10s"

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 -Dmanagement.endpoint.health.logging.slow-indicator-threshold="10s" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_LOGGING_SLOW_INDICATOR_THRESHOLD="10s"

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 --management.endpoint.health.logging.slow-indicator-threshold="10s"

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.

management.endpoint.health.probes.add-additional-paths=false

Whether to make the liveness and readiness health groups available on the main server port.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.probes.add-additional-paths=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      probes: 
        add-additional-paths: "..."

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 -Dmanagement.endpoint.health.probes.add-additional-paths="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_PROBES_ADD_ADDITIONAL_PATHS="..."

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 --management.endpoint.health.probes.add-additional-paths="..."

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.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.probes.enabled=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      probes: 
        enabled: "..."

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 -Dmanagement.endpoint.health.probes.enabled="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_PROBES_ENABLED="..."

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 --management.endpoint.health.probes.enabled="..."

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.

management.endpoint.health.roles=

Roles used to determine whether a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.roles=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      roles: "..."

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 -Dmanagement.endpoint.health.roles="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_ROLES="..."

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 --management.endpoint.health.roles="..."

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.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.show-components=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      show-components: "..."

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 -Dmanagement.endpoint.health.show-components="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_SHOW_COMPONENTS="..."

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 --management.endpoint.health.show-components="..."

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.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.show-details=never

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      show-details: "never"

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 -Dmanagement.endpoint.health.show-details="never" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_SHOW_DETAILS="never"

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 --management.endpoint.health.show-details="never"

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.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.status.http-mapping=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      status: 
        http-mapping: "..."

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 -Dmanagement.endpoint.health.status.http-mapping="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_STATUS_HTTP_MAPPING="..."

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 --management.endpoint.health.status.http-mapping="..."

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.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      status: 
        order: "["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]"

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 -Dmanagement.endpoint.health.status.order="["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_STATUS_ORDER="["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]"

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 --management.endpoint.health.status.order="["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]"

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.

management.endpoint.health.validate-group-membership=true

Whether to validate health group membership on startup. Validation fails if a group includes or excludes a health contributor that does not exist.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.validate-group-membership=true

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      validate-group-membership: "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 -Dmanagement.endpoint.health.validate-group-membership="true" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_VALIDATE_GROUP_MEMBERSHIP="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 --management.endpoint.health.validate-group-membership="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.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

_{How can I configure this property?}

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

Note

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

management.endpoints.enabled-by-default=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    enabled-by-default: "..."

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 -Dmanagement.endpoints.enabled-by-default="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_ENABLED_BY_DEFAULT="..."

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 --management.endpoints.enabled-by-default="..."

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.

management.endpoints.jackson.isolated-object-mapper=true

Whether to use an isolated object mapper to serialize endpoint JSON.

_{How can I configure this property?}

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

Note

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

management.endpoints.jackson.isolated-object-mapper=true

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jackson: 
      isolated-object-mapper: "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 -Dmanagement.endpoints.jackson.isolated-object-mapper="true" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_JACKSON_ISOLATED_OBJECT_MAPPER="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 --management.endpoints.jackson.isolated-object-mapper="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.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.jmx.domain=org.springframework.boot

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jmx: 
      domain: "org.springframework.boot"

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 -Dmanagement.endpoints.jmx.domain="org.springframework.boot" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_JMX_DOMAIN="org.springframework.boot"

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 --management.endpoints.jmx.domain="org.springframework.boot"

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.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

_{How can I configure this property?}

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

Note

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

management.endpoints.jmx.exposure.exclude=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jmx: 
      exposure: 
        exclude: "..."

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 -Dmanagement.endpoints.jmx.exposure.exclude="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_JMX_EXPOSURE_EXCLUDE="..."

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 --management.endpoints.jmx.exposure.exclude="..."

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.

management.endpoints.jmx.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

_{How can I configure this property?}

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

Note

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

management.endpoints.jmx.exposure.include=health

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jmx: 
      exposure: 
        include: "health"

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 -Dmanagement.endpoints.jmx.exposure.include="health" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_JMX_EXPOSURE_INCLUDE="health"

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 --management.endpoints.jmx.exposure.include="health"

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.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.jmx.static-names=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jmx: 
      static-names: "..."

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 -Dmanagement.endpoints.jmx.static-names="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_JMX_STATIC_NAMES="..."

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 --management.endpoints.jmx.static-names="..."

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.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

_{How can I configure this property?}

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

Note

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

management.endpoints.jmx.unique-names=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jmx: 
      unique-names: "..."

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 -Dmanagement.endpoints.jmx.unique-names="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_JMX_UNIQUE_NAMES="..."

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 --management.endpoints.jmx.unique-names="..."

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.

Deprecation status is ERRORwith a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

_{How can I configure this property?}

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

Note

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

management.endpoints.migrate-legacy-ids=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    migrate-legacy-ids: "..."

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 -Dmanagement.endpoints.migrate-legacy-ids="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_MIGRATE_LEGACY_IDS="..."

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 --management.endpoints.migrate-legacy-ids="..."

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.

management.endpoints.web.base-path=/actuator

Base path for Web endpoints. Relative to the servlet context path (server.servlet.context-path) or WebFlux base path (spring.webflux.base-path) when the management server is sharing the main server port. Relative to the management server base path (management.server.base-path) when a separate management server port (management.server.port) is configured.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.base-path=/actuator

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      base-path: "/actuator"

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 -Dmanagement.endpoints.web.base-path="/actuator" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_BASE_PATH="/actuator"

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 --management.endpoints.web.base-path="/actuator"

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.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.cors.allow-credentials=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        allow-credentials: "..."

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 -Dmanagement.endpoints.web.cors.allow-credentials="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_CORS_ALLOW_CREDENTIALS="..."

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 --management.endpoints.web.cors.allow-credentials="..."

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.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.cors.allowed-headers=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        allowed-headers: "..."

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 -Dmanagement.endpoints.web.cors.allowed-headers="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_CORS_ALLOWED_HEADERS="..."

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 --management.endpoints.web.cors.allowed-headers="..."

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.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.cors.allowed-methods=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        allowed-methods: "..."

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 -Dmanagement.endpoints.web.cors.allowed-methods="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_CORS_ALLOWED_METHODS="..."

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 --management.endpoints.web.cors.allowed-methods="..."

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.

management.endpoints.web.cors.allowed-origin-patterns=

Comma-separated list of origin patterns to allow. Unlike allowed origins which only supports '*', origin patterns are more flexible (for example 'https://*.example.com') and can be used when credentials are allowed. When no allowed origin patterns or allowed origins are set, CORS support is disabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.cors.allowed-origin-patterns=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        allowed-origin-patterns: "..."

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 -Dmanagement.endpoints.web.cors.allowed-origin-patterns="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_CORS_ALLOWED_ORIGIN_PATTERNS="..."

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 --management.endpoints.web.cors.allowed-origin-patterns="..."

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.

management.endpoints.web.cors.allowed-origins=

Comma-separated list of origins to allow. '*' allows all origins. When credentials are allowed, '*' cannot be used and origin patterns should be configured instead. When no allowed origins or allowed origin patterns are set, CORS support is disabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.cors.allowed-origins=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        allowed-origins: "..."

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 -Dmanagement.endpoints.web.cors.allowed-origins="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_CORS_ALLOWED_ORIGINS="..."

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 --management.endpoints.web.cors.allowed-origins="..."

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.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.cors.exposed-headers=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        exposed-headers: "..."

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 -Dmanagement.endpoints.web.cors.exposed-headers="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_CORS_EXPOSED_HEADERS="..."

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 --management.endpoints.web.cors.exposed-headers="..."

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.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.cors.max-age=1800s

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        max-age: "1800s"

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 -Dmanagement.endpoints.web.cors.max-age="1800s" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_CORS_MAX_AGE="1800s"

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 --management.endpoints.web.cors.max-age="1800s"

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.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.discovery.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      discovery: 
        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 -Dmanagement.endpoints.web.discovery.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_DISCOVERY_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 --management.endpoints.web.discovery.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.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.exposure.exclude=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      exposure: 
        exclude: "..."

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 -Dmanagement.endpoints.web.exposure.exclude="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_EXCLUDE="..."

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 --management.endpoints.web.exposure.exclude="..."

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.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.exposure.include=health

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      exposure: 
        include: "["health"]"

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 -Dmanagement.endpoints.web.exposure.include="["health"]" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE="["health"]"

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 --management.endpoints.web.exposure.include="["health"]"

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.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.web.path-mapping=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      path-mapping: "..."

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 -Dmanagement.endpoints.web.path-mapping="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_WEB_PATH_MAPPING="..."

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 --management.endpoints.web.path-mapping="..."

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.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

_{How can I configure this property?}

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

Note

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

management.health.binders.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    binders: 
      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 -Dmanagement.health.binders.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_BINDERS_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 --management.health.binders.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.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

_{How can I configure this property?}

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

Note

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

management.health.cassandra.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    cassandra: 
      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 -Dmanagement.health.cassandra.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_CASSANDRA_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 --management.health.cassandra.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.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

_{How can I configure this property?}

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

Note

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

management.health.couchbase.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    couchbase: 
      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 -Dmanagement.health.couchbase.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_COUCHBASE_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 --management.health.couchbase.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.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

_{How can I configure this property?}

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

Note

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

management.health.couchbase.timeout=1000ms

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    couchbase: 
      timeout: "1000ms"

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 -Dmanagement.health.couchbase.timeout="1000ms" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_COUCHBASE_TIMEOUT="1000ms"

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 --management.health.couchbase.timeout="1000ms"

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.

Deprecation status is ERRORwithout a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

_{How can I configure this property?}

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

Note

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

management.health.db.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    db: 
      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 -Dmanagement.health.db.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_DB_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 --management.health.db.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.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

_{How can I configure this property?}

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

Note

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

management.health.db.ignore-routing-data-sources=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    db: 
      ignore-routing-data-sources: "..."

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 -Dmanagement.health.db.ignore-routing-data-sources="..." -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_DB_IGNORE_ROUTING_DATA_SOURCES="..."

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 --management.health.db.ignore-routing-data-sources="..."

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.

management.health.defaults.enabled=true

Whether to enable default health indicators.

_{How can I configure this property?}

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

Note

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

management.health.defaults.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    defaults: 
      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 -Dmanagement.health.defaults.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_DEFAULTS_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 --management.health.defaults.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.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

_{How can I configure this property?}

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

Note

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

management.health.diskspace.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    diskspace: 
      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 -Dmanagement.health.diskspace.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_DISKSPACE_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 --management.health.diskspace.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.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

_{How can I configure this property?}

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

Note

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

management.health.diskspace.path=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    diskspace: 
      path: "..."

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 -Dmanagement.health.diskspace.path="..." -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_DISKSPACE_PATH="..."

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 --management.health.diskspace.path="..."

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.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

_{How can I configure this property?}

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

Note

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

management.health.diskspace.threshold=10MB

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    diskspace: 
      threshold: "10MB"

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 -Dmanagement.health.diskspace.threshold="10MB" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_DISKSPACE_THRESHOLD="10MB"

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 --management.health.diskspace.threshold="10MB"

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.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

_{How can I configure this property?}

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

Note

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

management.health.elasticsearch.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    elasticsearch: 
      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 -Dmanagement.health.elasticsearch.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_ELASTICSEARCH_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 --management.health.elasticsearch.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.

management.health.elasticsearch.indices=

Comma-separated index names.

_{How can I configure this property?}

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

Note

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

management.health.elasticsearch.indices=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    elasticsearch: 
      indices: "..."

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 -Dmanagement.health.elasticsearch.indices="..." -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_ELASTICSEARCH_INDICES="..."

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 --management.health.elasticsearch.indices="..."

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.

Deprecation status is ERRORwithout a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

_{How can I configure this property?}

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

Note

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

management.health.elasticsearch.response-timeout=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    elasticsearch: 
      response-timeout: "..."

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 -Dmanagement.health.elasticsearch.response-timeout="..." -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_ELASTICSEARCH_RESPONSE_TIMEOUT="..."

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 --management.health.elasticsearch.response-timeout="..."

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.

Deprecation status is ERRORwithout a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

_{How can I configure this property?}

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

Note

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

management.health.influxdb.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    influxdb: 
      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 -Dmanagement.health.influxdb.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_INFLUXDB_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 --management.health.influxdb.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.

management.health.jms.enabled=true

Whether to enable JMS health check.

_{How can I configure this property?}

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

Note

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

management.health.jms.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    jms: 
      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 -Dmanagement.health.jms.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_JMS_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 --management.health.jms.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.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

_{How can I configure this property?}

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

Note

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

management.health.ldap.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    ldap: 
      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 -Dmanagement.health.ldap.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_LDAP_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 --management.health.ldap.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.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

_{How can I configure this property?}

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

Note

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

management.health.livenessstate.enabled=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    livenessstate: 
      enabled: "..."

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 -Dmanagement.health.livenessstate.enabled="..." -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_LIVENESSSTATE_ENABLED="..."

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 --management.health.livenessstate.enabled="..."

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.

management.health.mail.enabled=true

Whether to enable Mail health check.

_{How can I configure this property?}

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

Note

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

management.health.mail.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    mail: 
      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 -Dmanagement.health.mail.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_MAIL_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 --management.health.mail.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.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

_{How can I configure this property?}

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

Note

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

management.health.mongo.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    mongo: 
      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 -Dmanagement.health.mongo.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_MONGO_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 --management.health.mongo.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.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

_{How can I configure this property?}

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

Note

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

management.health.neo4j.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    neo4j: 
      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 -Dmanagement.health.neo4j.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_NEO4J_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 --management.health.neo4j.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.

management.health.ping.enabled=true

Whether to enable ping health check.

_{How can I configure this property?}

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

Note

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

management.health.ping.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    ping: 
      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 -Dmanagement.health.ping.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_PING_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 --management.health.ping.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.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

_{How can I configure this property?}

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

Note

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

management.health.probes.enabled=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    probes: 
      enabled: "..."

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 -Dmanagement.health.probes.enabled="..." -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_PROBES_ENABLED="..."

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 --management.health.probes.enabled="..."

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.

Deprecation status is WARNINGwith a replacement setting: management.endpoint.health.probes.enabled.

management.health.pubsub.enabled=true

Whether to enable the Pub/Sub health indicator when used with Spring Boot Actuator.

_{How can I configure this property?}

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

Note

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

management.health.pubsub.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    pubsub: 
      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 -Dmanagement.health.pubsub.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_PUBSUB_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 --management.health.pubsub.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.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

_{How can I configure this property?}

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

Note

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

management.health.rabbit.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    rabbit: 
      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 -Dmanagement.health.rabbit.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_RABBIT_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 --management.health.rabbit.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.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

_{How can I configure this property?}

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

Note

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

management.health.readinessstate.enabled=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    readinessstate: 
      enabled: "..."

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 -Dmanagement.health.readinessstate.enabled="..." -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_READINESSSTATE_ENABLED="..."

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 --management.health.readinessstate.enabled="..."

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.

management.health.redis.enabled=true

Whether to enable Redis health check.

_{How can I configure this property?}

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

Note

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

management.health.redis.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    redis: 
      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 -Dmanagement.health.redis.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_REDIS_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 --management.health.redis.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.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

_{How can I configure this property?}

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

Note

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

management.health.refresh.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    refresh: 
      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 -Dmanagement.health.refresh.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_REFRESH_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 --management.health.refresh.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.

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

_{How can I configure this property?}

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

Note

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

management.health.zookeeper.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    zookeeper: 
      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 -Dmanagement.health.zookeeper.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_HEALTH_ZOOKEEPER_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 --management.health.zookeeper.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.

# Maximum time that a response can be cached.
# management.endpoint.health.cache.time-to-live=0ms

# Whether to enable the health endpoint.
# management.endpoint.health.enabled=true

# Health endpoint groups.
# management.endpoint.health.group=

# Threshold after which a warning will be logged for slow health indicators.
# management.endpoint.health.logging.slow-indicator-threshold=10s

# Whether to make the liveness and readiness health groups available on the main server port.
# management.endpoint.health.probes.add-additional-paths=false

# Whether to enable liveness and readiness probes.
# management.endpoint.health.probes.enabled=false

# Roles used to determine whether a user is authorized to be shown details.
# management.endpoint.health.roles=

# When to show components.
# management.endpoint.health.show-components=

# When to show full health details.
# management.endpoint.health.show-details=never

# Mapping of health statuses to HTTP status codes.
# management.endpoint.health.status.http-mapping=

# Comma-separated list of health statuses in order of severity.
# management.endpoint.health.status.order=["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]

# Whether to validate health group membership on startup.
# management.endpoint.health.validate-group-membership=true

# Whether to enable or disable all endpoints by default.
# management.endpoints.enabled-by-default=

# Whether to use an isolated object mapper to serialize endpoint JSON.
# management.endpoints.jackson.isolated-object-mapper=true

# Endpoints JMX domain name.
# management.endpoints.jmx.domain=org.springframework.boot

# Endpoint IDs that should be excluded or '*' for all.
# management.endpoints.jmx.exposure.exclude=

# Endpoint IDs that should be included or '*' for all.
# management.endpoints.jmx.exposure.include=health

# Additional static properties to append to all ObjectNames of MBeans representing Endpoints.
# management.endpoints.jmx.static-names=

# Whether unique runtime object names should be ensured.
# management.endpoints.jmx.unique-names=

# Whether to transparently migrate legacy endpoint IDs.
# management.endpoints.migrate-legacy-ids=false

# Base path for Web endpoints.
# management.endpoints.web.base-path=/actuator

# Whether credentials are supported.
# management.endpoints.web.cors.allow-credentials=

# Comma-separated list of headers to allow in a request. '*' allows all headers.
# management.endpoints.web.cors.allowed-headers=

# Comma-separated list of methods to allow. '*' allows all methods.
# management.endpoints.web.cors.allowed-methods=

# Comma-separated list of origin patterns to allow.
# management.endpoints.web.cors.allowed-origin-patterns=

# Comma-separated list of origins to allow. '*' allows all origins.
# management.endpoints.web.cors.allowed-origins=

# Comma-separated list of headers to include in a response.
# management.endpoints.web.cors.exposed-headers=

# How long the response from a pre-flight request can be cached by clients.
# management.endpoints.web.cors.max-age=1800s

# Whether the discovery page is enabled.
# management.endpoints.web.discovery.enabled=true

# Endpoint IDs that should be excluded or '*' for all.
# management.endpoints.web.exposure.exclude=

# Endpoint IDs that should be included or '*' for all.
# management.endpoints.web.exposure.include=["health"]

# Mapping between endpoint IDs and the path that should expose them.
# management.endpoints.web.path-mapping=

# Allows to enable/disable binder's' health indicators.
# management.health.binders.enabled=true

# Whether to enable Cassandra health check.
# management.health.cassandra.enabled=true

# Whether to enable Couchbase health check.
# management.health.couchbase.enabled=true

# Timeout for getting the Bucket information from the server.
# management.health.couchbase.timeout=1000ms

# Whether to enable database health check.
# management.health.db.enabled=true

# Whether to ignore AbstractRoutingDataSources when creating database health indicators.
# management.health.db.ignore-routing-data-sources=false

# Whether to enable default health indicators.
# management.health.defaults.enabled=true

# Whether to enable disk space health check.
# management.health.diskspace.enabled=true

# Path used to compute the available disk space.
# management.health.diskspace.path=

# Minimum disk space that should be available.
# management.health.diskspace.threshold=10MB

# Whether to enable Elasticsearch health check.
# management.health.elasticsearch.enabled=true

# Comma-separated index names.
# management.health.elasticsearch.indices=

# Time to wait for a response from the cluster.
# management.health.elasticsearch.response-timeout=

# Whether to enable InfluxDB health check.
# management.health.influxdb.enabled=true

# Whether to enable JMS health check.
# management.health.jms.enabled=true

# Whether to enable LDAP health check.
# management.health.ldap.enabled=true

# Whether to enable liveness state health check.
# management.health.livenessstate.enabled=false

# Whether to enable Mail health check.
# management.health.mail.enabled=true

# Whether to enable MongoDB health check.
# management.health.mongo.enabled=true

# Whether to enable Neo4j health check.
# management.health.neo4j.enabled=true

# Whether to enable ping health check.
# management.health.ping.enabled=true

# Whether to enable liveness and readiness probes.
# management.health.probes.enabled=false

# Whether to enable the Pub/Sub health indicator when used with Spring Boot Actuator.
# management.health.pubsub.enabled=true

# Whether to enable RabbitMQ health check.
# management.health.rabbit.enabled=true

# Whether to enable readiness state health check.
# management.health.readinessstate.enabled=false

# Whether to enable Redis health check.
# management.health.redis.enabled=true

# Enable the health endpoint for the refresh scope.
# management.health.refresh.enabled=true

# Enable the health endpoint for zookeeper.
# management.health.zookeeper.enabled=true

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

_{How can I configure this property?}

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

Note

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

spring.security.user.name=user

CAS properties can be specified using the YAML syntax:

spring: 
  security: 
    user: 
      name: "user"

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 -Dspring.security.user.name="user" -jar build/libs/cas.war

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

export SPRING_SECURITY_USER_NAME="user"

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 --spring.security.user.name="user"

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.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

_{How can I configure this property?}

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

Note

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

spring.security.user.password=...

CAS properties can be specified using the YAML syntax:

spring: 
  security: 
    user: 
      password: "..."

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 -Dspring.security.user.password="..." -jar build/libs/cas.war

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

export SPRING_SECURITY_USER_PASSWORD="..."

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 --spring.security.user.password="..."

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.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

_{How can I configure this property?}

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

Note

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

spring.security.user.roles=...

CAS properties can be specified using the YAML syntax:

spring: 
  security: 
    user: 
      roles: "..."

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 -Dspring.security.user.roles="..." -jar build/libs/cas.war

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

export SPRING_SECURITY_USER_ROLES="..."

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 --spring.security.user.roles="..."

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.

For basic authentication, the default username is casuser. The password may be automatically generated at startup and displayed in CAS logs if it is left undefined in CAS settings. Additional sources may also be defined that would authenticate the request via JAAS, LDAP, JDBC, etc.

Once endpoints are enabled and exposed, the security of all provided endpoints is handled by the Spring Security project. Protection and access to each endpoint is controlled via CAS settings individually such that you may decide a specific security level and method of authentication for each endpoint independently.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Delete all accounts.

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.gauthCredentialRepository.enabled=true
management.endpoints.web.exposure.include=gauthCredentialRepository

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.gauthCredentialRepository.access=PERMIT

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

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.form-login-enabled=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      form-login-enabled: "..."

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.monitor.endpoints.form-login-enabled="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_FORM_LOGIN_ENABLED="..."

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.monitor.endpoints.form-login-enabled="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.access=DENY

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.endpoint.gauthCredentialRepository.access=DENY

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        gauthCredentialRepository: 
          access: "DENY"

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.monitor.endpoints.endpoint.gauthCredentialRepository.access="DENY" -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_ENDPOINT_[KEY]_ACCESS="DENY"

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.monitor.endpoints.endpoint.gauthCredentialRepository.access="DENY"

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.endpoint.gauthCredentialRepository.required-authorities=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        gauthCredentialRepository: 
          required-authorities: "..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-authorities="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_ENDPOINT_[KEY]_REQUIRED_AUTHORITIES="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-authorities="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-ip-addresses=

Required IP addresses. CIDR ranges are accepted.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.endpoint.gauthCredentialRepository.required-ip-addresses=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        gauthCredentialRepository: 
          required-ip-addresses: "..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-ip-addresses="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_ENDPOINT_[KEY]_REQUIRED_IP_ADDRESSES="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-ip-addresses="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

_{How can I configure this property?}

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

Note

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

cas.monitor.endpoints.endpoint.gauthCredentialRepository.required-roles=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        gauthCredentialRepository: 
          required-roles: "..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-roles="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_ENDPOINT_[KEY]_REQUIRED_ROLES="..."

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.monitor.endpoints.endpoint.gauthCredentialRepository.required-roles="..."

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.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.cache.time-to-live=0ms

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      cache: 
        time-to-live: "0ms"

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 -Dmanagement.endpoint.health.cache.time-to-live="0ms" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_CACHE_TIME_TO_LIVE="0ms"

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 --management.endpoint.health.cache.time-to-live="0ms"

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.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      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 -Dmanagement.endpoint.health.enabled="true" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_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 --management.endpoint.health.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.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.group=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      group: "..."

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 -Dmanagement.endpoint.health.group="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_GROUP="..."

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 --management.endpoint.health.group="..."

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.

management.endpoint.health.logging.slow-indicator-threshold=10s

Threshold after which a warning will be logged for slow health indicators.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties$Logging.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.logging.slow-indicator-threshold=10s

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      logging: 
        slow-indicator-threshold: "10s"

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 -Dmanagement.endpoint.health.logging.slow-indicator-threshold="10s" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_LOGGING_SLOW_INDICATOR_THRESHOLD="10s"

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 --management.endpoint.health.logging.slow-indicator-threshold="10s"

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.

management.endpoint.health.probes.add-additional-paths=false

Whether to make the liveness and readiness health groups available on the main server port.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.probes.add-additional-paths=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      probes: 
        add-additional-paths: "..."

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 -Dmanagement.endpoint.health.probes.add-additional-paths="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_PROBES_ADD_ADDITIONAL_PATHS="..."

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 --management.endpoint.health.probes.add-additional-paths="..."

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.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.probes.enabled=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      probes: 
        enabled: "..."

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 -Dmanagement.endpoint.health.probes.enabled="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_PROBES_ENABLED="..."

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 --management.endpoint.health.probes.enabled="..."

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.

management.endpoint.health.roles=

Roles used to determine whether a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.roles=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      roles: "..."

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 -Dmanagement.endpoint.health.roles="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_ROLES="..."

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 --management.endpoint.health.roles="..."

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.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.show-components=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      show-components: "..."

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 -Dmanagement.endpoint.health.show-components="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_SHOW_COMPONENTS="..."

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 --management.endpoint.health.show-components="..."

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.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.show-details=never

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      show-details: "never"

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 -Dmanagement.endpoint.health.show-details="never" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_SHOW_DETAILS="never"

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 --management.endpoint.health.show-details="never"

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.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.status.http-mapping=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      status: 
        http-mapping: "..."

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 -Dmanagement.endpoint.health.status.http-mapping="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_STATUS_HTTP_MAPPING="..."

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 --management.endpoint.health.status.http-mapping="..."

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.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      status: 
        order: "["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]"

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 -Dmanagement.endpoint.health.status.order="["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_STATUS_ORDER="["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]"

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 --management.endpoint.health.status.order="["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]"

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.

management.endpoint.health.validate-group-membership=true

Whether to validate health group membership on startup. Validation fails if a group includes or excludes a health contributor that does not exist.

_{How can I configure this property?}

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

Note

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

management.endpoint.health.validate-group-membership=true

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      validate-group-membership: "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 -Dmanagement.endpoint.health.validate-group-membership="true" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_VALIDATE_GROUP_MEMBERSHIP="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 --management.endpoint.health.validate-group-membership="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.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

_{How can I configure this property?}

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

Note

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

management.endpoints.enabled-by-default=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    enabled-by-default: "..."

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 -Dmanagement.endpoints.enabled-by-default="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_ENABLED_BY_DEFAULT="..."

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 --management.endpoints.enabled-by-default="..."

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.

management.endpoints.jackson.isolated-object-mapper=true

Whether to use an isolated object mapper to serialize endpoint JSON.

_{How can I configure this property?}

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

Note

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

management.endpoints.jackson.isolated-object-mapper=true

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jackson: 
      isolated-object-mapper: "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 -Dmanagement.endpoints.jackson.isolated-object-mapper="true" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_JACKSON_ISOLATED_OBJECT_MAPPER="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 --management.endpoints.jackson.isolated-object-mapper="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.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

_{How can I configure this property?}

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

Note

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

management.endpoints.jmx.domain=org.springframework.boot

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jmx: 
      domain: "org.springframework.boot"

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 -Dmanagement.endpoints.jmx.domain="org.springframework.boot" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_JMX_DOMAIN="org.springframework.boot"

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 --management.endpoints.jmx.domain="org.springframework.boot"

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.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

_{How can I configure this property?}

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

Note

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

management.endpoints.jmx.exposure.exclude=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jmx: 
      exposure: 
        exclude: "..."

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 -Dmanagement.endpoints.jmx.exposure.exclude="..." -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_JMX_EXPOSURE_EXCLUDE="..."

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 --management.endpoints.jmx.exposure.exclude="..."

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.

management.endpoints.jmx.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

_{How can I configure this property?}

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

Note

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

management.endpoints.jmx.exposure.include=health

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jmx: 
      exposure: 
        include: "health"

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 -Dmanagement.endpoints.jmx.exposure.include="health" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINTS_JMX_EXPOSURE_INCLUDE="health"

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 --management.endpoints.jmx.exposure.include="health"

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.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

_{How can I configure this property?}

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

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.jmx.static-names=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jmx: 
      static-names: "..."

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 -Dmanagement.endpoints.jmx.static-names="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_JMX_STATIC_NAMES="..."

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 --management.endpoints.jmx.static-names="..."

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.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.jmx.unique-names=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    jmx: 
      unique-names: "..."

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 -Dmanagement.endpoints.jmx.unique-names="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_JMX_UNIQUE_NAMES="..."

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 --management.endpoints.jmx.unique-names="..."

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.

Deprecation status is ERRORwith a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.migrate-legacy-ids=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    migrate-legacy-ids: "..."

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 -Dmanagement.endpoints.migrate-legacy-ids="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_MIGRATE_LEGACY_IDS="..."

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 --management.endpoints.migrate-legacy-ids="..."

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.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.base-path=/actuator

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      base-path: "/actuator"

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 -Dmanagement.endpoints.web.base-path="/actuator" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_BASE_PATH="/actuator"

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 --management.endpoints.web.base-path="/actuator"

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.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.cors.allow-credentials=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        allow-credentials: "..."

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 -Dmanagement.endpoints.web.cors.allow-credentials="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_CORS_ALLOW_CREDENTIALS="..."

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 --management.endpoints.web.cors.allow-credentials="..."

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.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.cors.allowed-headers=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        allowed-headers: "..."

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 -Dmanagement.endpoints.web.cors.allowed-headers="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_CORS_ALLOWED_HEADERS="..."

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 --management.endpoints.web.cors.allowed-headers="..."

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.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.cors.allowed-methods=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        allowed-methods: "..."

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 -Dmanagement.endpoints.web.cors.allowed-methods="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_CORS_ALLOWED_METHODS="..."

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 --management.endpoints.web.cors.allowed-methods="..."

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.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.cors.allowed-origin-patterns=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        allowed-origin-patterns: "..."

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 -Dmanagement.endpoints.web.cors.allowed-origin-patterns="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_CORS_ALLOWED_ORIGIN_PATTERNS="..."

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 --management.endpoints.web.cors.allowed-origin-patterns="..."

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.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.cors.allowed-origins=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        allowed-origins: "..."

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 -Dmanagement.endpoints.web.cors.allowed-origins="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_CORS_ALLOWED_ORIGINS="..."

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 --management.endpoints.web.cors.allowed-origins="..."

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.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.cors.exposed-headers=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        exposed-headers: "..."

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 -Dmanagement.endpoints.web.cors.exposed-headers="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_CORS_EXPOSED_HEADERS="..."

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 --management.endpoints.web.cors.exposed-headers="..."

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.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.cors.max-age=1800s

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      cors: 
        max-age: "1800s"

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 -Dmanagement.endpoints.web.cors.max-age="1800s" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_CORS_MAX_AGE="1800s"

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 --management.endpoints.web.cors.max-age="1800s"

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.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.discovery.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      discovery: 
        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 -Dmanagement.endpoints.web.discovery.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_DISCOVERY_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 --management.endpoints.web.discovery.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.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.exposure.exclude=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      exposure: 
        exclude: "..."

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 -Dmanagement.endpoints.web.exposure.exclude="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_EXCLUDE="..."

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 --management.endpoints.web.exposure.exclude="..."

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.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.exposure.include=health

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      exposure: 
        include: "["health"]"

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 -Dmanagement.endpoints.web.exposure.include="["health"]" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE="["health"]"

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 --management.endpoints.web.exposure.include="["health"]"

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.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.endpoints.web.path-mapping=...

CAS properties can be specified using the YAML syntax:

management: 
  endpoints: 
    web: 
      path-mapping: "..."

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 -Dmanagement.endpoints.web.path-mapping="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_ENDPOINTS_WEB_PATH_MAPPING="..."

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 --management.endpoints.web.path-mapping="..."

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.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.binders.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    binders: 
      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 -Dmanagement.health.binders.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_BINDERS_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 --management.health.binders.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.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.cassandra.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    cassandra: 
      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 -Dmanagement.health.cassandra.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_CASSANDRA_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 --management.health.cassandra.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.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.couchbase.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    couchbase: 
      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 -Dmanagement.health.couchbase.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_COUCHBASE_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 --management.health.couchbase.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.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.couchbase.timeout=1000ms

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    couchbase: 
      timeout: "1000ms"

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 -Dmanagement.health.couchbase.timeout="1000ms" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_COUCHBASE_TIMEOUT="1000ms"

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 --management.health.couchbase.timeout="1000ms"

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.

Deprecation status is ERRORwithout a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.db.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    db: 
      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 -Dmanagement.health.db.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_DB_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 --management.health.db.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.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.db.ignore-routing-data-sources=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    db: 
      ignore-routing-data-sources: "..."

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 -Dmanagement.health.db.ignore-routing-data-sources="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_DB_IGNORE_ROUTING_DATA_SOURCES="..."

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 --management.health.db.ignore-routing-data-sources="..."

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.

management.health.defaults.enabled=true

Whether to enable default health indicators.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.defaults.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    defaults: 
      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 -Dmanagement.health.defaults.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_DEFAULTS_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 --management.health.defaults.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.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.diskspace.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    diskspace: 
      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 -Dmanagement.health.diskspace.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_DISKSPACE_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 --management.health.diskspace.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.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.diskspace.path=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    diskspace: 
      path: "..."

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 -Dmanagement.health.diskspace.path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_DISKSPACE_PATH="..."

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 --management.health.diskspace.path="..."

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.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.diskspace.threshold=10MB

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    diskspace: 
      threshold: "10MB"

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 -Dmanagement.health.diskspace.threshold="10MB" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_DISKSPACE_THRESHOLD="10MB"

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 --management.health.diskspace.threshold="10MB"

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.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.elasticsearch.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    elasticsearch: 
      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 -Dmanagement.health.elasticsearch.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_ELASTICSEARCH_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 --management.health.elasticsearch.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.

management.health.elasticsearch.indices=

Comma-separated index names.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.elasticsearch.indices=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    elasticsearch: 
      indices: "..."

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 -Dmanagement.health.elasticsearch.indices="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_ELASTICSEARCH_INDICES="..."

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 --management.health.elasticsearch.indices="..."

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.

Deprecation status is ERRORwithout a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.elasticsearch.response-timeout=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    elasticsearch: 
      response-timeout: "..."

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 -Dmanagement.health.elasticsearch.response-timeout="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_ELASTICSEARCH_RESPONSE_TIMEOUT="..."

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 --management.health.elasticsearch.response-timeout="..."

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.

Deprecation status is ERRORwithout a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.influxdb.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    influxdb: 
      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 -Dmanagement.health.influxdb.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_INFLUXDB_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 --management.health.influxdb.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.

management.health.jms.enabled=true

Whether to enable JMS health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.jms.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    jms: 
      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 -Dmanagement.health.jms.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_JMS_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 --management.health.jms.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.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.ldap.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    ldap: 
      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 -Dmanagement.health.ldap.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_LDAP_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 --management.health.ldap.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.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.livenessstate.enabled=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    livenessstate: 
      enabled: "..."

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 -Dmanagement.health.livenessstate.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_LIVENESSSTATE_ENABLED="..."

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 --management.health.livenessstate.enabled="..."

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.

management.health.mail.enabled=true

Whether to enable Mail health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.mail.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    mail: 
      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 -Dmanagement.health.mail.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_MAIL_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 --management.health.mail.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.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.mongo.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    mongo: 
      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 -Dmanagement.health.mongo.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_MONGO_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 --management.health.mongo.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.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.neo4j.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    neo4j: 
      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 -Dmanagement.health.neo4j.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_NEO4J_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 --management.health.neo4j.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.

management.health.ping.enabled=true

Whether to enable ping health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.ping.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    ping: 
      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 -Dmanagement.health.ping.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_PING_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 --management.health.ping.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.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.probes.enabled=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    probes: 
      enabled: "..."

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 -Dmanagement.health.probes.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_PROBES_ENABLED="..."

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 --management.health.probes.enabled="..."

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.

Deprecation status is WARNINGwith a replacement setting: management.endpoint.health.probes.enabled.

management.health.pubsub.enabled=true

Whether to enable the Pub/Sub health indicator when used with Spring Boot Actuator.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.pubsub.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    pubsub: 
      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 -Dmanagement.health.pubsub.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_PUBSUB_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 --management.health.pubsub.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.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.rabbit.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    rabbit: 
      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 -Dmanagement.health.rabbit.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_RABBIT_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 --management.health.rabbit.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.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.readinessstate.enabled=...

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    readinessstate: 
      enabled: "..."

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 -Dmanagement.health.readinessstate.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_READINESSSTATE_ENABLED="..."

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 --management.health.readinessstate.enabled="..."

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.

management.health.redis.enabled=true

Whether to enable Redis health check.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.redis.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    redis: 
      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 -Dmanagement.health.redis.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_REDIS_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 --management.health.redis.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.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.refresh.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    refresh: 
      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 -Dmanagement.health.refresh.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_REFRESH_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 --management.health.refresh.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.

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

management.health.zookeeper.enabled=true

CAS properties can be specified using the YAML syntax:

management: 
  health: 
    zookeeper: 
      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 -Dmanagement.health.zookeeper.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export MANAGEMENT_HEALTH_ZOOKEEPER_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 --management.health.zookeeper.enabled="true"