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

Interface Verisign.Service

All Superinterfaces:

Binding.Service, Binding.Service, Maskable, ResultLimitable, Service

Enclosing class:

Verisign

@ApiService("SoftLayer_User_Customer_External_Binding_Verisign")
public static interface Verisign.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 VeriSign. 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 VeriSign credential. Once the security code has been authenticated with VeriSign the user will be allowed access to the SoftLayer customer portal.

The VeriSign external binding service allows a user to create an external binding, enable, disable, or unlock an external binding, and delete an external binding. Currently SoftLayer provides the master account user of a SoftLayer account with one free VeriSign external binding. All subsequent VeriSign external bindings will need to be created by placing an order.

Once a SoftLayer user has a valid and active VeriSign 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.

See Also:

SoftLayer_User_Customer_External_Binding_Verisign

Method Summary

Modifier and Type	Method	Description
Verisign.ServiceAsync	asAsync()	Get an async version of this service
Boolean	deleteObjectForVerisign()	Delete a VeriSign external binding.
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	enableForVerisign()	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.
String	getActivationCodeForMobileClient()	An activation code is required when provisioning a new mobile credential from Verisign.
String	getCredentialExpirationDate()	The date that a VeriSign credential expires.
String	getCredentialLastUpdateDate()	The last time a VeriSign credential was updated.
String	getCredentialState()	The current state of a VeriSign credential.
String	getCredentialType()	The type of VeriSign credential.
Verisign	getObjectForVerisign()
void	setMask(Verisign.Mask mask)
Boolean	unlock(String securityCode)	If a VeriSign credential becomes locked because of too many failed login attempts the unlock method can be used to unlock a VeriSign credential.
Boolean	validateCredentialId(Long userId, String externalId)	Validate the user id and VeriSign credential id used to create an external authentication binding.
Verisign.Mask	withMask()	Use the existing mask on this service or create it if not present
Verisign.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

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.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

Verisign.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Binding.Service

Specified by:

asAsync in interface Binding.Service

Specified by:

asAsync in interface Service

withNewMask

Verisign.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 interface Binding.Service

Specified by:

withNewMask in interface Binding.Service

Specified by:

withNewMask in interface Maskable

withMask

Verisign.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Binding.Service

Specified by:

withMask in interface Binding.Service

Specified by:

withMask in interface Maskable

setMask

void setMask(Verisign.Mask mask)

deleteObjectForVerisign

@ApiMethod(value="deleteObject",
           instanceRequired=true)
Boolean deleteObjectForVerisign()

Delete a VeriSign external binding. The only VeriSign external binding that can be deleted through this method is the free VeriSign external binding for the master user of a SoftLayer account. All other external bindings must be canceled using the SoftLayer service cancellation form.

When a VeriSign external binding is deleted the credential is deactivated in VeriSign's system for use on the SoftLayer site and the $0 billing item associated with the free VeriSign external binding is cancelled.

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::deleteObject

disable

@ApiMethod(instanceRequired=true)
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.

You may supply one of the following reason when you disable an external binding:
*Unspecified
*TemporarilyUnavailable
*Lost
*Stolen

Specified by:

disable in interface Binding.Service

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::disable

enableForVerisign

@ApiMethod(value="enable",
           instanceRequired=true)
Boolean enableForVerisign()

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.

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::enable

getActivationCodeForMobileClient

@ApiMethod
String getActivationCodeForMobileClient()

An activation code is required when provisioning a new mobile credential from Verisign. This method will return the required activation code.

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::getActivationCodeForMobileClient

getObjectForVerisign

@ApiMethod(value="getObject",
           instanceRequired=true)
Verisign getObjectForVerisign()

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::getObject

unlock

@ApiMethod(instanceRequired=true)
Boolean unlock(String securityCode)

If a VeriSign credential becomes locked because of too many failed login attempts the unlock method can be used to unlock a VeriSign credential. As a security precaution a valid security code generated by the credential will be required before the credential is unlocked.

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::unlock

validateCredentialId

@ApiMethod
Boolean validateCredentialId(Long userId,
                             String externalId)

Validate the user id and VeriSign credential id used to create an external authentication binding.

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::validateCredentialId

getCredentialExpirationDate

@ApiMethod(instanceRequired=true)
String getCredentialExpirationDate()

The date that a VeriSign credential expires.

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::getCredentialExpirationDate

getCredentialLastUpdateDate

@ApiMethod(instanceRequired=true)
String getCredentialLastUpdateDate()

The last time a VeriSign credential was updated.

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::getCredentialLastUpdateDate

getCredentialState

@ApiMethod(instanceRequired=true)
String getCredentialState()

The current state of a VeriSign credential. This can be 'Enabled', 'Disabled', or 'Locked'.

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::getCredentialState

getCredentialType

@ApiMethod(instanceRequired=true)
String getCredentialType()

The type of VeriSign credential. This can be either 'Hardware' or 'Software'.

See Also:

SoftLayer_User_Customer_External_Binding_Verisign::getCredentialType