Interface Phone.Service
- All Superinterfaces:
Binding.Service
,Binding.Service
,Maskable
,ResultLimitable
,Service
- Enclosing class:
- Phone
@ApiService("SoftLayer_User_Customer_External_Binding_Phone") public static interface Phone.Service extends Binding.Service
SoftLayer provides its customers the ability to add an additional layer of security to the SoftLayer customer portal by requiring that a user login and authenticate with a trusted 3rd party before they are given access to their SoftLayer account. This is accomplished by creating an external binding for a specific vendor such as PhoneFactor. When the SoftLayer user attempts to log in to the SoftLayer customer portal or VPN, they will first be prompted for their normal SoftLayer username and password. Once that information is verified they will be asked to authenticate via phone, SMS or mobile phone application. Once authenticated with the trusted vendor the user will be allowed access to the SoftLayer customer portal or VPN.
The Phone external binding service allows a user to create an external binding, enable, disable, or unlock an external binding, and delete an external binding.
Once a SoftLayer user has a valid and active external binding, they will be required to always use their credential to login to the SoftLayer customer portal. In addition any user with an active external binding will be prohibited from using the API.
The Phone external binding service allows a user to create an external binding, enable, disable, or unlock an external binding, and delete an external binding.
Once a SoftLayer user has a valid and active external binding, they will be required to always use their credential to login to the SoftLayer customer portal. In addition any user with an active external binding will be prohibited from using the API.
-
Method Summary
Modifier and Type Method Description Phone.ServiceAsync
asAsync()
Get an async version of this serviceBoolean
checkPhoneValidationResult(String token)
Return a phone validation result.Boolean
disable(String reason)
Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal.Boolean
enableForPhone()
Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal.List<String>
getAllAuthenticationModes()
This service returns key names of all available authentication modes.List<String>
getAllAuthenticationPinModes(String authenticationModeKeyName)
This service returns key names of all available authentication modes.Mode
getAuthenticationMode()
String
getBindingStatus()
The current external binding status.Phone
getObjectForPhone()
List<Attribute>
getPhoneAppActivationCode()
Some vendor's mobile app requires an activation code.List<Phone>
getPhoneData()
String
getPinLength()
String
requestPhoneValidation(Phone phoneData)
Initiates a phone validation requests and returns a unique token.void
setMask(Phone.Mask mask)
Boolean
updateAuthenticationMode(Mode mode)
This service allow you to change your phone authentication mode.Boolean
updatePhone(List<Phone> phoneData)
Phone external binding supports a primary and a backup phone number.Phone.Mask
withMask()
Use the existing mask on this service or create it if not presentPhone.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return itMethods inherited from interface com.softlayer.api.service.user.customer.external.Binding.Service
enable, getObjectForBinding, getUser, setMask
Methods inherited from interface com.softlayer.api.service.user.external.Binding.Service
deleteObject, getAttributes, getBillingItem, getNote, getObject, getType, getVendor, setMask, updateNote
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
Method Details
-
asAsync
Phone.ServiceAsync asAsync()Description copied from interface:Service
Get an async version of this service- Specified by:
asAsync
in interfaceBinding.Service
- Specified by:
asAsync
in interfaceBinding.Service
- Specified by:
asAsync
in interfaceService
-
withNewMask
Phone.Mask withNewMask()Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceBinding.Service
- Specified by:
withNewMask
in interfaceBinding.Service
- Specified by:
withNewMask
in interfaceMaskable
-
withMask
Phone.Mask withMask()Description copied from interface:Maskable
Use the existing mask on this service or create it if not present- Specified by:
withMask
in interfaceBinding.Service
- Specified by:
withMask
in interfaceBinding.Service
- Specified by:
withMask
in interfaceMaskable
-
setMask
-
checkPhoneValidationResult
Return a phone validation result. -
disable
Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal.
You may supply one of the following reason when you disable an external binding:
*Unspecified
*TemporarilyUnavailable
*Lost
*Stolen- Specified by:
disable
in interfaceBinding.Service
- See Also:
- SoftLayer_User_Customer_External_Binding_Phone::disable
-
enableForPhone
Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal.
Please note that API access will be disabled for users that have an active external binding. -
getAllAuthenticationModes
This service returns key names of all available authentication modes. See [[SoftLayer_Container_User_Customer_External_Binding_Phone_Mode|authentication mode]] container for details. -
getAllAuthenticationPinModes
@ApiMethod(instanceRequired=true) List<String> getAllAuthenticationPinModes(String authenticationModeKeyName)This service returns key names of all available authentication modes. Refer to [[SoftLayer_User_Customer_External_Binding_Phone::getAllAuthenticationModes|getAllAuthenticationModes]] to retrieve authentication mode key names. -
getAuthenticationMode
-
getObjectForPhone
-
getPhoneAppActivationCode
Some vendor's mobile app requires an activation code. Use this method to get an activation data. -
getPhoneData
-
requestPhoneValidation
Initiates a phone validation requests and returns a unique token. Use [[SoftLayer_User_Customer_External_Binding_Phone::checkPhoneValidationResult|checkPhoneValidationResult]] to find the phone validation result. -
updateAuthenticationMode
This service allow you to change your phone authentication mode. See [[SoftLayer_Container_User_Customer_External_Binding_Phone_Mode|authentication mode]] container for available modes. -
updatePhone
Phone external binding supports a primary and a backup phone number. You can use this method to update your phone number used for the phone authentication. You can provide an array of [[SoftLayer_Container_User_Data_Phone|User Phone]] objects. You have to mark one as the primary phone number by setting "phoneType" to "PRIMARY".
*countryCode: Country code number for the phone number. Default: 1 (United States & Canada +1)
*phone: Phone number that 2 Form Factor system will call or text for user authentication.
The phone number format must match the format selected in the Country Code.
*extension: Specify the extension that will be dialed after the call is answered. Digits, commas, *, and #
are allowed. Commas can be used for a one second pause to navigate phone system menus.
*phoneType: Specify the primary and backup phone number by setting this value to "PRIMARY" or "BACKUP".
If omitted, it will be considered to be the primary phone number. If you are passing two Phone objects, you must specify the phone type of each phone number.
-
getBindingStatus
The current external binding status. It can be "ACTIVE" or "BLOCKED". -
getPinLength
-