Class MMFARegistration


public class MMFARegistration extends LocalMechanism
A class representing a users Mobile Multi-Factor Authentication registration.
  • Method Details

    • getAuthenticatorId

      public String getAuthenticatorId()
      Getter for the Authenticator ID of this MMFA registration.
      Returns:
      The Authenticator ID.
    • isEnabled

      public boolean isEnabled()
      Getter for the enabled/disabled status of this MMFA registration.
      Returns:
      A boolean to indicate whether this MMFA registration is enabled or not.
    • isPreferred

      public boolean isPreferred()
      Getter for the preferred status of this MMFA registration.
      Returns:
      A boolean to indicate whether this MMFA registration is the users preferred registration.
    • getDeviceName

      public String getDeviceName()
      Getter for the device name of the device associated with this MMFA registration.
      Returns:
      The device name of the device.
    • getDeviceType

      public String getDeviceType()
      Getter for the device type of the device associated with this MMFA registration.
      Returns:
      The device type of the device.
    • getOSVersion

      public String getOSVersion()
      Getter for the OS version of the device associated with this MMFA registration.
      Returns:
      The OS version of the device.
    • hasUserPresenceEnrolled

      public boolean hasUserPresenceEnrolled()
      Getter for the enrollment status of the MMFA User Presence method.
      Returns:
      A boolean to indicate whether User Presence method is enrolled or not.
    • hasFingerprintEnrolled

      public boolean hasFingerprintEnrolled()
      Getter for the enrollment status of the MMFA Fingerprint method.
      Returns:
      A boolean to indicate whether Fingerprint method is enrolled or not.
    • toJson

      public JSONObject toJson()
      Get a JSON formatted representation of this MMFARegistration. Example:
       {
           "mechanismURI" : "urn:ibm:security:authentication:asf:mechanism:mmfa",
           "authenticatorId": "1252b95e-0050-4c3c-8540-45eba210787d",
           "enabled": true,
           "preferred": true,
           "deviceName": "Example Device",
           "deviceType": "iPhone",
           "osVersion": "12.0",
           "userPresenceEnrolled": true,
           "fingerprintEnrolled": true
       }
       
      Overrides:
      toJson in class LocalMechanism
      Returns:
      A JSONObject representation of this MMFARegistration.
      See Also: