com.ibm.security.access.mobile.authentication

Class MfaRegistrationResult

  • java.lang.Object
    • com.ibm.security.access.mobile.authentication.MfaRegistrationResult
  • All Implemented Interfaces:
    IResult


    public final class MfaRegistrationResult
    extends java.lang.Object
    implements IResult
    Holds the result of the user registration.
    Since:
    1.2.0
    Version:
    1.2.8
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.HashMap<java.lang.String,java.lang.Object> getAdditionalData()
      Returns additional registration details from Access Manager.
      java.lang.String getBiometricSampleUrl()
      Returns the biometrics sample endpoint of Access Manager.
      java.lang.String getClientId()
      Returns the unique identifier between the service and the app.
      java.lang.String getEnrollmentUrl()
      Returns the challenge enrollment endpoint of Access Manager.
      java.lang.String getErrorDescription()
      Returns detailed information about the error.
      java.lang.String getHotpUrl()
      Returns the counter based one-time password token generator endpoint of Access Manager.
      MobileKitException getMobileKitException()
      Returns the exception in case of an error.
      java.lang.String getOauthTokenUrl()
      Returns the OAuth token endpoint of Access Manager.
      java.lang.String getServiceName()
      Returns the name of the service representing the Access Manager instance.
      java.lang.String getTotpUrl()
      Returns the time based one-time password token generator endpoint of Access Manager.
      java.lang.String getTransactionsUrl()
      Returns the transaction endpoint of Access Manager.
      boolean hasError()
      Returns whether to indicate an error.
      static MfaRegistrationResult parse(org.json.JSONObject data)
      Returns an instance of MfaRegistrationResult parsed from the object.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getOauthTokenUrl

        public java.lang.String getOauthTokenUrl()
        Returns the OAuth token endpoint of Access Manager.
        Returns:
        OAuth token end point of Access Manager
      • getEnrollmentUrl

        public java.lang.String getEnrollmentUrl()
        Returns the challenge enrollment endpoint of Access Manager.
        Returns:
        Enrollment challenge end point of Access Manager
      • getTransactionsUrl

        public java.lang.String getTransactionsUrl()
        Returns the transaction endpoint of Access Manager.
        Returns:
        message end point of Access Manager
      • getClientId

        public java.lang.String getClientId()
        Returns the unique identifier between the service and the app.
        Returns:
        the unique identifier between the service and the app
      • getHotpUrl

        public java.lang.String getHotpUrl()
        Returns the counter based one-time password token generator endpoint of Access Manager.
        Returns:
        the counter based one-time password token generator endpoint of Access Manager
      • getTotpUrl

        public java.lang.String getTotpUrl()
        Returns the time based one-time password token generator endpoint of Access Manager.
        Returns:
        the time based one-time password token generator endpoint of Access Manager
      • getBiometricSampleUrl

        public java.lang.String getBiometricSampleUrl()
        Returns the biometrics sample endpoint of Access Manager.
        Returns:
        the biometrics sample endpoinr of Access Manager.
      • getAdditionalData

        public java.util.HashMap<java.lang.String,java.lang.Object> getAdditionalData()
        Returns additional registration details from Access Manager.
        Returns:
        Additional registration details from Access Manager
      • hasError

        public boolean hasError()
        Returns whether to indicate an error.
        Returns:
        true if there has been an error,
        false otherwise
      • getErrorDescription

        public java.lang.String getErrorDescription()
        Returns detailed information about the error.
        Specified by:
        getErrorDescription in interface IResult
        Returns:
        the detailed information of the error or null if unknown.
      • getServiceName

        public java.lang.String getServiceName()
        Returns the name of the service representing the Access Manager instance.

        the value is determined by the presence of a key in the dictionary called service_name. This value can be configured in Template Files under Secure Access Control on the appliance by creating mmfa\\user\\mgmt\\metadata\\<oauth_client_id>\\metadata.json. In the absence of service_name, the value of the OAuth client_id is used, which is also configurable on the appliance.

        Returns:
        the name of the service representing the Access Manager instance