Package com.softlayer.api.service.container.user.customer.external.binding.phone

Class Mode

  • @ApiType("SoftLayer_Container_User_Customer_External_Binding_Phone_Mode")
public class Mode
extends Entity
    This container can be used to configure the phone authentication mode. By default, "VOICE_CALL" in "STANDARD" mode with no Pin number will be used. With the default mode, you will have to answer a phone call from a trusted 2 form factor vendor during authentication process. You have to answer the call and follow the instruction in order to complete the authentication.

    You can also use SMS text message or PhoneFactor mobile app modes (in case you're using PhoneFactor). Additionally, you can set up a Pin number. By requiring you to verify your secret PIN, you can ensure that you have possession of your phone.
    See Also:
    SoftLayer_Container_User_Customer_External_Binding_Phone_Mode

    • Field Detail

      • mode

        @ApiProperty(canBeNullOrNotSet=true)
protected String mode
        Authentication mode. Valid modes are: VOICE_CALL, SMS_TEXT, PHONE_APP


        *VOICE_CALL
        In this mode, users will receive a phone call to authenticate. Using PIN can enhance the security of the phone authentication by requiring the user to enter a PIN during the authentication call. Valid Pin modes are: PIN, VOICE_PRINT, STANDARD


        **STANDARD: (default) No PIN is used.
        **PIN: 4 to 10 digit numeric value
        **VOICE_PRINT: The user's voice will be used to identify the user.


        *SMS_TEXT
        SMS Text mode will send a SMS text message to the user's phone to complete the authentication. There are 2 different pin modes:


        **OTP: (default) A text message containing a One-Time Passcode (OTP) is sent to the user. The user must reply to the text message entering this OTP to complete the authentication.
        **OTP_PIN: This mode enhances the security of the authentication by requiring the user to enter the OTP + their PIN in the text reply.




        *PHONE_APP
        This mode is applicable for PhoneFactor. Phone App mode results in a notification being sent to the user's PhoneFactor phone app. There are 2 different pin modes for the mobile app authentication.
        **STANDARD: (default) The first authentication is when the user signs on using a username and password.
        The second authentication is when the user receives a notification in the PhoneFactor phone app. In Standard Mode, users will prompted to authenticate, deny, or deny and report fraud.
        **PIN: This mode enhances the security of the authentication by requiring the user to enter their PIN in the phone app.

      • modeSpecified

        protected boolean modeSpecified

      • pinSpecified

        protected boolean pinSpecified

      • pinModeSpecified

        protected boolean pinModeSpecified

    • Constructor Detail

      • Mode

        public Mode()

    • Method Detail

      • getMode

        public String getMode()

      • setMode

        public void setMode​(String mode)

      • isModeSpecified

        public boolean isModeSpecified()

      • unsetMode

        public void unsetMode()

      • getPin

        public String getPin()

      • setPin

        public void setPin​(String pin)

      • isPinSpecified

        public boolean isPinSpecified()

      • unsetPin

        public void unsetPin()

      • getPinMode

        public String getPinMode()

      • setPinMode

        public void setPinMode​(String pinMode)

      • isPinModeSpecified

        public boolean isPinModeSpecified()

      • unsetPinMode

        public void unsetPinMode()