Configure Service Expiration Policy

An application registered with CAS may be assigned an optional expiration policy that controls the lifetime of the registration. Once the service is deemed expired, it will automatically be disabled or removed from the CAS registry and relevant contacts defined and assigned to the service will be notified via email or text messages.

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

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

  • cas.service-registry.mail.attribute-name=

    • Principal attribute names that indicates the destination email address for this message. The attributes must already be resolved and available to the CAS principal. When multiple attributes are specified, each attribute is then examined against the available CAS principal to locate the email address value, which may result in multiple emails being sent.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.support.email.EmailProperties.
  • cas.service-registry.mail.from=

    • Email from address.

    org.apereo.cas.configuration.model.support.email.EmailProperties.
  • cas.service-registry.mail.subject=

    • Email subject line.

    The subject can either be defined verbaitm, or it may point to a message key in the language bundle using the syntax #{subject-language-key}. This key should point to a valid message defined in the appropriate language bundle that is then picked up via the active locale. In case where the language code cannot resolve the real subject, a default subject value would be used.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.support.email.EmailProperties.
  • cas.service-registry.sms.attribute-name=phone

    • Principal attribute name that indicates the destination phone number for this SMS message. The attribute must already be resolved and available to the CAS principal.

    org.apereo.cas.configuration.model.support.sms.SmsProperties.
  • cas.service-registry.sms.from=

    • The from address for the message.

    org.apereo.cas.configuration.model.support.sms.SmsProperties.
  • cas.service-registry.sms.text=

    • The body of the SMS message.

    org.apereo.cas.configuration.model.support.sms.SmsProperties.
    The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.

  • cas.service-registry.mail.bcc=

    • Email BCC address, if any.

    org.apereo.cas.configuration.model.support.email.EmailProperties.
  • cas.service-registry.mail.cc=

    • Email CC address, if any.

    org.apereo.cas.configuration.model.support.email.EmailProperties.
  • cas.service-registry.mail.html=false

    • Indicate whether the message body should be evaluated as HTML text.

    org.apereo.cas.configuration.model.support.email.EmailProperties.
  • cas.service-registry.mail.priority=1

    • Set the priority (X-Priority header) of the message. Values: 1 (Highest), 2 (High), 3 (Normal), 4 (Low), 5 (Lowest).

    org.apereo.cas.configuration.model.support.email.EmailProperties.
  • cas.service-registry.mail.reply-to=

    • Email Reply-To address, if any.

    org.apereo.cas.configuration.model.support.email.EmailProperties.
  • cas.service-registry.mail.text=

    • Email message body. Could be plain text or a reference to an external file that would serve as a template.

    If specified as a path to an external file with an extension .gtemplate, then the email message body would be processed using the Groovy template engine. The template engine uses JSP style <% %> script and <%= %> expression syntax or GString style expressions. The variable out is bound to the writer that the template is being written to.

    If using plain text, the contents are processed for string subtitution candidates using named variables. For example, you may refer to an expected url variable in the email text via ${url}, or use ${token} to locate the token variable. In certain cases, additional parameters are passed to the email body processor that might include authentication and/or principal attributes, the available locale, client http information, etc.

    org.apereo.cas.configuration.model.support.email.EmailProperties.
  • cas.service-registry.mail.validate-addresses=false

    • Set whether to validate all addresses which get passed to this helper.

    org.apereo.cas.configuration.model.support.email.EmailProperties.