Spring Cloud Configuration Server - Spring Cloud HashiCorp Vault

Spring Cloud Configuration Server is able to use Vault to locate properties and settings. To learn more about configuration security, please review this guide.

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

Third Party
Notes

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


No data available in table

_{The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.}

Show entries

Search:

spring.cloud.vault.app-id.app-id-path=app-id

Mount path of the AppId authentication backend.

org.springframework.cloud.vault.config.VaultProperties$AppIdProperties.

_{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:


1

spring.cloud.vault.app-id.app-id-path=app-id

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:

spring: 
  cloud: 
    vault: 
      app-id: 
        app-id-path: "app-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 -Dspring.cloud.vault.app-id.app-id-path="app-id" -jar build/libs/cas.war

The above example assumes 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 SPRING_CLOUD_VAULT_APP_ID_APP_ID_PATH="app-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 --spring.cloud.vault.app-id.app-id-path="app-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.

spring.cloud.vault.app-id.network-interface=

Network interface hint for the "MAC_ADDRESS" UserId mechanism.

org.springframework.cloud.vault.config.VaultProperties$AppIdProperties.

_{How can I configure this property?}

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

Note

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


1

spring.cloud.vault.app-id.network-interface=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      app-id: 
        network-interface: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with 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.cloud.vault.app-id.network-interface="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APP_ID_NETWORK_INTERFACE="..."

java -jar build/libs/cas.war

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

CAS 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.cloud.vault.app-id.network-interface="..."

The above example assumes 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.cloud.vault.app-id.user-id=MAC_ADDRESS

UserId mechanism. Can be either "MAC_ADDRESS", "IP_ADDRESS", a string or a class name.

org.springframework.cloud.vault.config.VaultProperties$AppIdProperties.

_{How can I configure this property?}

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

Note

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


1

spring.cloud.vault.app-id.user-id=MAC_ADDRESS

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      app-id: 
        user-id: "MAC_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 -Dspring.cloud.vault.app-id.user-id="MAC_ADDRESS" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APP_ID_USER_ID="MAC_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 --spring.cloud.vault.app-id.user-id="MAC_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.

spring.cloud.vault.app-role.app-role-path=approle

Mount path of the AppRole authentication backend.

org.springframework.cloud.vault.config.VaultProperties$AppRoleProperties.

_{How can I configure this property?}

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

Note

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


1

spring.cloud.vault.app-role.app-role-path=approle

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      app-role: 
        app-role-path: "approle"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with 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.cloud.vault.app-role.app-role-path="approle" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APP_ROLE_APP_ROLE_PATH="approle"

java -jar build/libs/cas.war

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

CAS 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.cloud.vault.app-role.app-role-path="approle"

The above example assumes 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.cloud.vault.app-role.role-id=

The RoleId.

org.springframework.cloud.vault.config.VaultProperties$AppRoleProperties.

_{How can I configure this property?}

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

Note

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


1

spring.cloud.vault.app-role.role-id=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      app-role: 
        role-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 -Dspring.cloud.vault.app-role.role-id="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APP_ROLE_ROLE_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 --spring.cloud.vault.app-role.role-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.

Showing 1 to 5 of 77 entries

Previous1 2 3 4 5…16Next

# Mount path of the AppId authentication backend.
# spring.cloud.vault.app-id.app-id-path=app-id

# Network interface hint for the "MAC_ADDRESS" UserId mechanism.
# spring.cloud.vault.app-id.network-interface=

# UserId mechanism.
# spring.cloud.vault.app-id.user-id=MAC_ADDRESS

# Mount path of the AppRole authentication backend.
# spring.cloud.vault.app-role.app-role-path=approle

# Name of the role, optional, used for pull-mode.
# spring.cloud.vault.app-role.role=

# The RoleId.
# spring.cloud.vault.app-role.role-id=

# The SecretId.
# spring.cloud.vault.app-role.secret-id=

# Application name for AppId authentication.
# spring.cloud.vault.application-name=application

# 
# spring.cloud.vault.authentication=token

# Mount path of the AWS-EC2 authentication backend.
# spring.cloud.vault.aws-ec2.aws-ec2-path=aws-ec2

# URL of the AWS-EC2 PKCS7 identity document.
# spring.cloud.vault.aws-ec2.identity-document=http://169.254.169.254/latest/dynamic/instance-identity/pkcs7

# Nonce used for AWS-EC2 authentication.
# spring.cloud.vault.aws-ec2.nonce=

# Name of the role, optional.
# spring.cloud.vault.aws-ec2.role=

# Mount path of the AWS authentication backend.
# spring.cloud.vault.aws-iam.aws-path=aws

# STS server URI.
# spring.cloud.vault.aws-iam.endpoint-uri=

# Name of the region, optional.
# spring.cloud.vault.aws-iam.region=

# Name of the role, optional.
# spring.cloud.vault.aws-iam.role=

# Name of the server used to set {@code X-Vault-AWS-IAM-Server-ID} header in the headers of login requests.
# spring.cloud.vault.aws-iam.server-name=

# Mount path of the Azure MSI authentication backend.
# spring.cloud.vault.azure-msi.azure-path=azure

# Identity token service URI.
# spring.cloud.vault.azure-msi.identity-token-service=

# Instance metadata service URI.
# spring.cloud.vault.azure-msi.metadata-service=

# Name of the role.
# spring.cloud.vault.azure-msi.role=

# Enable lifecycle management.
# spring.cloud.vault.config.lifecycle.enabled=true

# The expiry threshold.
# spring.cloud.vault.config.lifecycle.expiry-threshold=

# Set the {@link LeaseEndpoints} to delegate renewal/revocation calls to.
# spring.cloud.vault.config.lifecycle.lease-endpoints=

# Sets the {@link LeaseStrategy} to be used with {@link org.springframework.vault.core.lease.SecretLeaseContainer#setLeaseStrategy(LeaseStrategy)} to retain or drop tokens on renewal errors.
# spring.cloud.vault.config.lifecycle.lease-strategy=

# The time period that is at least required before renewing a lease.
# spring.cloud.vault.config.lifecycle.min-renewal=

# Used to set a {@link org.springframework.core.env.PropertySource} priority.
# spring.cloud.vault.config.order=0

# Connection timeout.
# spring.cloud.vault.connection-timeout=5000

# Flag to indicate that Vault server discovery is enabled (vault server URL will be looked up via discovery).
# spring.cloud.vault.discovery.enabled=false

# Service id to locate Vault.
# spring.cloud.vault.discovery.service-id=vault

# Enable Vault config server.
# spring.cloud.vault.enabled=true

# Fail fast if data cannot be obtained from Vault.
# spring.cloud.vault.fail-fast=false

# Mount path of the Kubernetes authentication backend.
# spring.cloud.vault.gcp-gce.gcp-path=gcp

# Name of the role against which the login is being attempted.
# spring.cloud.vault.gcp-gce.role=

# Optional service account id.
# spring.cloud.vault.gcp-gce.service-account=

# The base64 encoded contents of an OAuth2 account private key in JSON format.
# spring.cloud.vault.gcp-iam.credentials.encoded-key=

# Location of the OAuth2 credentials private key.
# spring.cloud.vault.gcp-iam.credentials.location=

# Mount path of the Kubernetes authentication backend.
# spring.cloud.vault.gcp-iam.gcp-path=gcp

# Validity of the JWT token.
# spring.cloud.vault.gcp-iam.jwt-validity=15m

# Overrides the GCP project Id.
# spring.cloud.vault.gcp-iam.project-id=

# Name of the role against which the login is being attempted.
# spring.cloud.vault.gcp-iam.role=

# Overrides the GCP service account Id.
# spring.cloud.vault.gcp-iam.service-account-id=

# Vault server host.
# spring.cloud.vault.host=localhost

# Mount path of the Kubernetes authentication backend.
# spring.cloud.vault.kubernetes.kubernetes-path=kubernetes

# Name of the role against which the login is being attempted.
# spring.cloud.vault.kubernetes.role=

# Path to the service account token file.
# spring.cloud.vault.kubernetes.service-account-token-file=/var/run/secrets/kubernetes.io/serviceaccount/token

# Application name to be used for the context.
# spring.cloud.vault.kv.application-name=application

# Name of the default backend.
# spring.cloud.vault.kv.backend=secret

# Key-Value backend version.
# spring.cloud.vault.kv.backend-version=2

# Name of the default context.
# spring.cloud.vault.kv.default-context=application

# Enable the key-value backend.
# spring.cloud.vault.kv.enabled=true

# Profile-separator to combine application name and profile.
# spring.cloud.vault.kv.profile-separator=/

# List of active profiles.
# spring.cloud.vault.kv.profiles=

# Vault namespace (requires Vault Enterprise).
# spring.cloud.vault.namespace=

# Path to the instance certificate (PEM).
# spring.cloud.vault.pcf.instance-certificate=

# Path to the instance key (PEM).
# spring.cloud.vault.pcf.instance-key=

# Mount path of the Kubernetes authentication backend.
# spring.cloud.vault.pcf.pcf-path=pcf

# Name of the role against which the login is being attempted.
# spring.cloud.vault.pcf.role=

# Vault server port.
# spring.cloud.vault.port=8200

# Flag to indicate that reactive discovery is enabled
# spring.cloud.vault.reactive.enabled=true

# Read timeout.
# spring.cloud.vault.read-timeout=15000

# Protocol scheme.
# spring.cloud.vault.scheme=https

# Enable session lifecycle management.
# spring.cloud.vault.session.lifecycle.enabled=true

# The expiry threshold for a {@link LoginToken}.
# spring.cloud.vault.session.lifecycle.expiry-threshold=7s

# The time period that is at least required before renewing the {@link LoginToken}.
# spring.cloud.vault.session.lifecycle.refresh-before-expiry=5s

# Mount path of the TLS cert authentication backend.
# spring.cloud.vault.ssl.cert-auth-path=cert

# List of enabled SSL/TLS cipher suites.
# spring.cloud.vault.ssl.enabled-cipher-suites=

# List of enabled SSL/TLS protocol.
# spring.cloud.vault.ssl.enabled-protocols=

# Trust store that holds certificates and private keys.
# spring.cloud.vault.ssl.key-store=

# Password used to access the key store.
# spring.cloud.vault.ssl.key-store-password=

# Type of the key store.
# spring.cloud.vault.ssl.key-store-type=

# Trust store that holds SSL certificates.
# spring.cloud.vault.ssl.trust-store=

# Password used to access the trust store.
# spring.cloud.vault.ssl.trust-store-password=

# Type of the trust store.
# spring.cloud.vault.ssl.trust-store-type=

# Static vault token.
# spring.cloud.vault.token=

# Vault URI.
# spring.cloud.vault.uri=

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.

Usage

The configuration modules provided here may also be used verbatim inside a CAS server overlay and do not exclusively belong to a Spring Cloud Configuration server. While this module is primarily useful when inside the Spring Cloud Configuration server, it nonetheless may also be used inside a CAS server overlay directly to fetch settings from a source.

Actuator Endpoints

The following endpoints are provided by CAS:

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

Show entries

Search:

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:


1

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-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:


1

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:


1

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=

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:


1

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:


1

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.

Showing 1 to 5 of 6 entries

Previous1 2Next

Show entries

Search:

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:


1

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:


1

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.connection-timeout=PT30S

Indicates the maximum number of milliseconds that the service can wait to obtain a connection.

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:


1

cas.monitor.endpoints.jdbc.connection-timeout=PT30S

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      jdbc: 
        connection-timeout: "PT30S"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with 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.connection-timeout="PT30S" -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_CONNECTION_TIMEOUT="PT30S"

java -jar build/libs/cas.war

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

CAS 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.connection-timeout="PT30S"

The above example assumes that 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:


1

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:


1

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.

Showing 1 to 5 of 35 entries

Previous1 2 3 4 5 6 7Next

# 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

# Indicates the maximum number of milliseconds that the service can wait to obtain a connection.
# cas.monitor.endpoints.jdbc.connection-timeout=PT30S

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

Show entries

Search:

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:


1

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:


1

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:


1

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:


1

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.

Showing 1 to 4 of 4 entries

Previous1Next

Show entries

Search:

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:


1

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


1

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


1

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:


1

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:


1

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.

Showing 1 to 5 of 7 entries

Previous1 2Next

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

To prepare CAS to support and integrate with Apache Groovy, please review this guide.

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

Show entries

Search:

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:


1

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:


1

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:


1

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:


1

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:


1

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.

Showing 1 to 5 of 6 entries

Previous1 2Next

Show entries

Search:

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:


1

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:


1

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:


1

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:


1

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:


1

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.

Showing 1 to 5 of 75 entries

Previous1 2 3 4 5…15Next

# 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(...)`.

To prepare CAS to support and integrate with Apache Groovy, please review this guide.

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

Optional

Show entries

Search:

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:


1

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:


1

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:


1

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.

Showing 1 to 3 of 3 entries

Previous1Next

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

Required

Show entries

Search:

cas.monitor.endpoints.json.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.core.monitor.JsonSecurityActuatorEndpointsMonitorProperties.

_{How can I configure this property?}

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

Note

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


1

cas.monitor.endpoints.json.location=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      json: 
        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.monitor.endpoints.json.location="..." -jar build/libs/cas.war

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

export CAS_MONITOR_ENDPOINTS_JSON_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.monitor.endpoints.json.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.

Showing 1 to 1 of 1 entries

Previous1Next

GET	`/cas/actuator/health`

Reports back general health status of the system, produced by various monitors.

Once the endpoint is available, here is an example of how you could use it with curl:

curl -k -u "username:password" \
-X GET \
-X "Content-Type: application/json" \
-X "Accept: application/json" \
"https://sso.example.org/cas/actuator/health?"

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.health.enabled=true
management.endpoints.web.exposure.include=health

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.health.access=PERMIT

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

Optional

Show entries

Search:

cas.monitor.endpoints.endpoint.health.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:


1

cas.monitor.endpoints.endpoint.health.access=DENY

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        health: 
          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.health.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.health.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.health.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:


1

cas.monitor.endpoints.endpoint.health.required-authorities=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        health: 
          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.health.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.health.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.health.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:


1

cas.monitor.endpoints.endpoint.health.required-ip-addresses=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        health: 
          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.health.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.health.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.health.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:


1

cas.monitor.endpoints.endpoint.health.required-roles=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        health: 
          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.health.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.health.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.

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:


1

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.

Showing 1 to 5 of 5 entries

Previous1Next

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

Show entries

Search:

management.endpoint.health.access=unrestricted

Permitted level of access for 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:


1

management.endpoint.health.access=unrestricted

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      access: "unrestricted"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with 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.access="unrestricted" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_ACCESS="unrestricted"

java -jar build/libs/cas.war

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

CAS 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.access="unrestricted"

The above example assumes 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.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:


1

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:


1

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.

Deprecation status is WARNINGwith a replacement setting: management.endpoint.health.access.

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:


1

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:


1

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.

Showing 1 to 5 of 65 entries

Previous1 2 3 4 5…13Next

# Permitted level of access for the health endpoint.
# management.endpoint.health.access=unrestricted

# 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=

# 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

# Default access level for all endpoints.
# management.endpoints.access.default=

# The maximum level of endpoint access that is permitted.
# management.endpoints.access.max-permitted=unrestricted

# 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=

# List of headers to allow in a request. '*' allows all headers.
# management.endpoints.web.cors.allowed-headers=

# List of methods to allow. '*' allows all methods.
# management.endpoints.web.cors.allowed-methods=

# List of origin patterns to allow.
# management.endpoints.web.cors.allowed-origin-patterns=

# List of origins to allow. '*' allows all origins.
# management.endpoints.web.cors.allowed-origins=

# 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

# If an SSL Certificate will be invalid within the time span defined by this threshold, it should trigger a warning.
# management.health.ssl.certificate-validity-warning-threshold=14d

# Whether to enable SSL certificate health check.
# management.health.ssl.enabled=true

# Enable the health endpoint for zookeeper.
# management.health.zookeeper.enabled=true

The health endpoint may also be configured to show details via the following conditions:

URL	Description
`never`	Never display details of health monitors.
`always`	Always display details of health monitors.
`when-authorized`	Details are only shown to authorized users. Authorized roles can be configured using `management.endpoint.health.roles`.

The results and details of the health endpoints are produced by a number of health indicator components that may monitor different systems, such as LDAP connection pools, database connections, etc.

management.health.refresh.enabled=true
management.health.vaultHealthIndicator.enabled=true

Show entries

Search:

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:


1

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:


1

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:


1

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.

Showing 1 to 3 of 3 entries

Previous1Next

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.

This option allows you to define a static list of users, passwords along with their role in a JSON file. The JSON file should be formatted as follows:

[
    {
        "username": "casuser",
        "password": "{sha512}<hashed-password>",
        "authorities": [ "ROLE_ADMIN" ]
    }
]

Supported password encoding schemes are: {sha512}, {sha256}, {bcrypt}, {noop}, {pbkdf2}, {scrypt}, {argon2}.

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>

Reports back general health status of the system, produced by various monitors.

Once the endpoint is available, here is an example of how you could use it with curl:

curl -k -u "username:password" \
-X GET \
-X "Content-Type: application/json" \
-X "Accept: application/json" \
"https://sso.example.org/cas/actuator/health/{path}?"

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.health.enabled=true
management.endpoints.web.exposure.include=health

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.health.access=PERMIT

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

Optional

Show entries

Search:

cas.monitor.endpoints.endpoint.health.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:


1

cas.monitor.endpoints.endpoint.health.access=DENY

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        health: 
          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.health.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.health.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.health.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:


1

cas.monitor.endpoints.endpoint.health.required-authorities=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        health: 
          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.health.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.health.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.health.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:


1

cas.monitor.endpoints.endpoint.health.required-ip-addresses=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        health: 
          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.health.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.health.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.health.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:


1

cas.monitor.endpoints.endpoint.health.required-roles=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    endpoints: 
      endpoint: 
        health: 
          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.health.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.health.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.

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:


1

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.

Showing 1 to 5 of 5 entries

Previous1Next

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

Show entries

Search:

management.endpoint.health.access=unrestricted

Permitted level of access for 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:


1

management.endpoint.health.access=unrestricted

CAS properties can be specified using the YAML syntax:

management: 
  endpoint: 
    health: 
      access: "unrestricted"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with 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.access="unrestricted" -jar build/libs/cas.war

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

export MANAGEMENT_ENDPOINT_HEALTH_ACCESS="unrestricted"

java -jar build/libs/cas.war

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

CAS 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.access="unrestricted"

The above example assumes 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.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:


1

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:


1

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.

Deprecation status is WARNINGwith a replacement setting: management.endpoint.health.access.

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:


1

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:


1

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"