Class FIDORegistration


public class FIDORegistration extends LocalMechanism
A class representing a users FIDO2 registration.
  • Method Details

    • getCredentialId

      public String getCredentialId()
      Getter for the Credential ID of this FIDO Registration.
      Returns:
      The Credential ID.
    • getRPId

      public String getRPId()
      Getter for the Relying Party ID of this FIDO Registration.
      Returns:
      The Relying Party ID.
    • isEnabled

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

      public String getNickname()
      Getter for the user defined nickname of this FIDO Registration.
      Returns:
      The nickname of this FIDO Registration.
    • wasUserVerified

      public boolean wasUserVerified()
      Getter for the user verified status of this FIDO Registration. userVerified is an indicator for whether user verification was done as a part of the registration process.
      Returns:
      A boolean to indicate whether user verification was performed for this FIDORegistration.
    • wasUserPresent

      public boolean wasUserPresent()
      Getter for the user present status of this FIDO Registration. userPresent is an indicator for whether user was present during the registration process.
      Returns:
      A boolean to indicate whether user was present during registration of this FIDORegistration.
    • getCounter

      public long getCounter()
      Getter for the counter of this FIDORegistration.
      Returns:
      The stored value for counter of this FIDORegistration.
    • getMetadataDescription

      public String getMetadataDescription()
      Getter for the description of the Metadata associated with this FIDORegistration.
      Returns:
      The metadata description for this FIDORegistration.
    • getMetadataIcon

      public String getMetadataIcon()
      Getter for the base64 encoded icon string of the Metadata associated with this FIDORegistration.
      Returns:
      The base64 String of the metadata icon for this FIDORegistration.
    • getType

      public String getType()
      Getter for the type of this FIDORegistration. Possible values are "WebAuthn" to indicate a FIDO2/WebAuthn authenticator was registered. "U2F" indicates a U2F authenticator was used.
      Returns:
      The type for this FIDORegistration.
    • getCreatedDate

      public Date getCreatedDate()
      Getter for the creation date/time of this EULA.
      Returns:
      The creation date formatted in ISO 8601 Date format.
    • getLastUsed

      public Date getLastUsed()
      Getter for the date/time that this registration was last used.
      Returns:
      The last used date formatted in ISO 8601 Date format.
    • getBackupEligibility

      public boolean getBackupEligibility()
      Getter for the backup eligibility of this FIDORegistration. A value of true means the public key credential source can to be backed up. A value of false means the public key credential source cannot be backed up.
      Returns:
      boolean
    • getBackupState

      public boolean getBackupState()
      Getter for the backup state of this FIDORegistration. A value of true means the public key credential source is currently backed up. A value of false means the public key credential source is not currently backed up.
      Returns:
      boolean
    • getTransports

      public List<String> getTransports()
      Getter for the transports associated with this FIDORegistration.
      Returns:
      An list of the transports of this FIDORegistration.
    • toJson

      public JSONObject toJson()
      Get a JSON formatted representation of this FIDORegistration. Example:
       {
           "mechanismURI" : "urn:ibm:security:authentication:asf:mechanism:fido2",
           "rpId": "example.com",
           "enabled": true,
           "nickname": "Example Authenticator",
           "userVerified": true,
           "userPresent": true,
           "counter": 1,
           "metadata": {
               "description": "Example Authenticator description",
               "icon": "data:image/png;base64,iVBORw0KGgoAAAAN....."
           },
           "type": "WebAuthn",
           "created": "1970-01-01T00:00:00+0000",
           "lastUsed": "1970-01-01T00:00:00+0000",
           "backupEligibility": false,
           "backupState": false
       }
       
      Overrides:
      toJson in class LocalMechanism
      Returns:
      A JSONObject representation of this FIDORegistration.
      See Also: