Package org.apereo.cas.configuration.model.core.authentication.risk

Class RiskBasedAuthenticationResponseProperties

java.lang.Object
org.apereo.cas.configuration.model.core.authentication.risk.RiskBasedAuthenticationResponseProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-support-electrofence") public class RiskBasedAuthenticationResponseProperties extends Object implements Serializable
This is RiskBasedAuthenticationResponseProperties.
Since:
7.0.0
See Also:

  • Constructor Details

    • RiskBasedAuthenticationResponseProperties

      public RiskBasedAuthenticationResponseProperties()

  • Method Details

    • isBlockAttempt

      public boolean isBlockAttempt()
      If an authentication attempt is deemed risky, block the response and do not allow further attempts.

    • getMfaProvider

      public String getMfaProvider()
      If an authentication attempt is deemed risky, force a multi-factor authentication event noted by the provider id here.

    • getRiskyAuthenticationAttribute

      public String getRiskyAuthenticationAttribute()
      If an authentication attempt is deemed risky, communicate the nature of this attempt back to the application via a special attribute in the final CAS response indicated here.

    • getRiskVerificationTokenExpiration

      public String getRiskVerificationTokenExpiration()
      Control the expiration window of the verification token that can be used to verify and confirm risky authentication attempts.

    • getGetRiskVerificationHistory

      public String getGetRiskVerificationHistory()
      Risk confirmation attempts are only evaluated up to a point in history, controlled by this setting. That is to say, authentication attempts that are detected as risky are evaluated against previous confirmations in history using this time window. Once we move beyond this point in the history of authentication attempts, the confirmations no longer hold and the user will be asked to verify their attempt again.

    • getMail

      public EmailProperties getMail()
      Email settings for notifications, If an authentication attempt is deemed risky.

    • getSms

      public SmsProperties getSms()
      SMS settings for notifications, If an authentication attempt is deemed risky.

    • setBlockAttempt

      public RiskBasedAuthenticationResponseProperties setBlockAttempt(boolean blockAttempt)
      If an authentication attempt is deemed risky, block the response and do not allow further attempts.
      Returns:
      this.

    • setMfaProvider

      public RiskBasedAuthenticationResponseProperties setMfaProvider(String mfaProvider)
      If an authentication attempt is deemed risky, force a multi-factor authentication event noted by the provider id here.
      Returns:
      this.

    • setRiskyAuthenticationAttribute

      public RiskBasedAuthenticationResponseProperties setRiskyAuthenticationAttribute(String riskyAuthenticationAttribute)
      If an authentication attempt is deemed risky, communicate the nature of this attempt back to the application via a special attribute in the final CAS response indicated here.
      Returns:
      this.

    • setRiskVerificationTokenExpiration

      public RiskBasedAuthenticationResponseProperties setRiskVerificationTokenExpiration(String riskVerificationTokenExpiration)
      Control the expiration window of the verification token that can be used to verify and confirm risky authentication attempts.
      Returns:
      this.

    • setGetRiskVerificationHistory

      public RiskBasedAuthenticationResponseProperties setGetRiskVerificationHistory(String getRiskVerificationHistory)
      Risk confirmation attempts are only evaluated up to a point in history, controlled by this setting. That is to say, authentication attempts that are detected as risky are evaluated against previous confirmations in history using this time window. Once we move beyond this point in the history of authentication attempts, the confirmations no longer hold and the user will be asked to verify their attempt again.
      Returns:
      this.

    • setMail

      public RiskBasedAuthenticationResponseProperties setMail(EmailProperties mail)
      Email settings for notifications, If an authentication attempt is deemed risky.
      Returns:
      this.

    • setSms

      public RiskBasedAuthenticationResponseProperties setSms(SmsProperties sms)
      SMS settings for notifications, If an authentication attempt is deemed risky.
      Returns:
      this.