com.ibm.security.access.mobile.authentication

Class UserPresenceEnrollment

  • java.lang.Object
    • com.ibm.security.access.mobile.authentication.UserPresenceEnrollment
  • All Implemented Interfaces:
    IEnrollment, IScimEnrollment


    public final class UserPresenceEnrollment
    extends java.lang.Object
    implements IScimEnrollment
    The enrollment for simple user-presence.
    Since:
    1.2.0
    Version:
    1.2.8
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getAlgorithm()
      Returns the name of the algorithm to sign the data.
      java.lang.String getIdentifier()
      Returns the identifier of the enrollment.
      java.lang.String getKeyHandle()
      Returns the name that can be used to identify the key handle.
      java.lang.String getMethod()
      Returns the type of HTTP method required for enrollment.
      java.lang.String getName()
      Returns the name of the enrollment.
      java.lang.String getPublicKey()
      Returns the public key used to be stored.
      java.lang.String getQueryString()
      Returns additional attributes for enrolling in SCIM interface.
      java.lang.String getType()
      Returns the type of the enrollment challenge.
      boolean isEnabled()
      Returns the flag to indicate whether the enrollment challenge is enabled.
      org.json.JSONObject serializeToJson()
      Returns a JSON string of the serialized UserPresenceEnrollment object.
      void setEnabled(boolean enabled)
      Set the flag to indicate whether the enrollment challenge is enabled.
      void setKeyHandle(java.lang.String keyHandle)
      Sets the key handle.
      void setPublicKey(java.lang.String publicKey)
      Sets the public key.
      • Methods inherited from class java.lang.Object

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

      • UserPresenceEnrollment

        public UserPresenceEnrollment()
    • Method Detail

      • getType

        public java.lang.String getType()
        Returns the type of the enrollment challenge.
        Specified by:
        getType in interface IEnrollment
      • getName

        public java.lang.String getName()
        Returns the name of the enrollment.
        Specified by:
        getName in interface IEnrollment
      • getIdentifier

        public java.lang.String getIdentifier()
        Returns the identifier of the enrollment.
        Specified by:
        getIdentifier in interface IEnrollment
        Returns:
        the identifier of the enrollment
      • getMethod

        public java.lang.String getMethod()
        Returns the type of HTTP method required for enrollment. This must be GET or POST.
        Specified by:
        getMethod in interface IEnrollment
      • getAlgorithm

        public java.lang.String getAlgorithm()
        Returns the name of the algorithm to sign the data.
        Returns:
        the name of the algorithm to sign the data
      • getPublicKey

        public java.lang.String getPublicKey()
        Returns the public key used to be stored.
        Returns:
        the public key used to be stored
      • setEnabled

        public void setEnabled(boolean enabled)
        Set the flag to indicate whether the enrollment challenge is enabled.
        Specified by:
        setEnabled in interface IEnrollment
        Parameters:
        enabled - the flag to indicate whether the enrollment challenge is enabled
      • setPublicKey

        public void setPublicKey(java.lang.String publicKey)
        Sets the public key.
        Parameters:
        publicKey - The public key to be set.
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • getKeyHandle

        public java.lang.String getKeyHandle()
        Returns the name that can be used to identify the key handle.
        Specified by:
        getKeyHandle in interface IScimEnrollment
      • setKeyHandle

        public void setKeyHandle(java.lang.String keyHandle)
        Sets the key handle.
        Specified by:
        setKeyHandle in interface IScimEnrollment
        Parameters:
        keyHandle - the key handle to be set
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • getQueryString

        public java.lang.String getQueryString()
        Returns additional attributes for enrolling in SCIM interface.
        Specified by:
        getQueryString in interface IScimEnrollment
      • isEnabled

        public boolean isEnabled()
        Returns the flag to indicate whether the enrollment challenge is enabled.
        Specified by:
        isEnabled in interface IEnrollment
        Specified by:
        isEnabled in interface IScimEnrollment