Interface Totp.Service
-
- All Superinterfaces:
Binding.Service
,Binding.Service
,Maskable
,ResultLimitable
,Service
- Enclosing class:
- Totp
@ApiService("SoftLayer_User_Customer_External_Binding_Totp") public static interface Totp.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, in this case Time-based One Time Password. When the SoftLayer user attempts to log in to the SoftLayer customer portal they will first be prompted for their normal SoftLayer username and password. Once that information is verified they will be asked to generate and provide a security code from their Time-based One Time Password application. Once the security code has been authenticated the user will be allowed access to the SoftLayer customer portal.
The time-based one time password external binding service allows a user to create an external binding, enable, disable, and delete an external binding.
Once a SoftLayer user has a valid and active time-based one time password 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Boolean
activate()
Totp.ServiceAsync
asAsync()
Get an async version of this serviceBoolean
deactivate()
String
generateSecretKey()
Totp
getObjectForTotp()
void
setMask(Totp.Mask mask)
Totp.Mask
withMask()
Use the existing mask on this service or create it if not presentTotp.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.service.user.customer.external.Binding.Service
disable, 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 Detail
-
asAsync
Totp.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
Totp.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
Totp.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
void setMask(Totp.Mask mask)
-
activate
@ApiMethod(instanceRequired=true) Boolean activate()
-
deactivate
@ApiMethod(instanceRequired=true) Boolean deactivate()
-
generateSecretKey
@ApiMethod String generateSecretKey()
-
getObjectForTotp
@ApiMethod(value="getObject", instanceRequired=true) Totp getObjectForTotp()
-
-