Class MfaFailed


  • public class MfaFailed
    extends Object
    An API state model containing additional details for states in which the user has failed multi-factor authentication.
    Since:
    10.1
    • Constructor Detail

      • MfaFailed

        public MfaFailed()
    • Method Detail

      • getCode

        public String getCode()
        Get the error code.
      • setCode

        public void setCode​(String code)
        Set the error code.
      • getMessage

        public String getMessage()
        Get the developer-facing error message.
      • setMessage

        public void setMessage​(String message)
        Set the developer-facing error message.
      • getUserMessage

        public String getUserMessage()
        Get the user-facing error message. A user-facing error message should be provided for any error likely to be displayed to the end user. A localizable message key can be provided with setUserMessageKey() or the localized error message can be directly set with setUserMessage().
      • setUserMessage

        public void setUserMessage​(String userMessage)
        Set the user-facing error message. Where possible, the message should be user-friendly and localized.
      • setUserMessageKey

        public void setUserMessageKey​(String userMessageKey)
        Set the user-facing error message key. In the JSON serialization this key will automatically be converted to a localized string if a corresponding message is defined in the authn-api-messages or pingfederate-messages properties file for the user's locale.
      • getUserMessageKey

        public String getUserMessageKey()
        Get the user-facing error message key.