com.softlayer.api.service.user.customer.external.binding.Totp Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.user.customer.external.binding;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.user.customer.external.Binding;
import java.util.concurrent.Future;

/**
 * The SoftLayer_User_Customer_External_Binding_Totp data type contains information about a single time-based one time password external binding.  The external binding information is used when a SoftLayer customer logs into the SoftLayer customer portal to authenticate them. 

 * 

 * The information provided by this external binding data type includes: 

 * * The type of credential

 * * The current state of the credential

 * ** Active

 * ** Inactive

 * 

 * 

 * SoftLayer users with an active external binding will be prohibited from using the API for security reasons. 
 *
 * @see SoftLayer_User_Customer_External_Binding_Totp
 */
@ApiType("SoftLayer_User_Customer_External_Binding_Totp")
public class Totp extends Binding {

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * 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. 
     *
     * @see SoftLayer_User_Customer_External_Binding_Totp
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_User_Customer_External_Binding_Totp")
    public static interface Service extends Binding.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * @see SoftLayer_User_Customer_External_Binding_Totp::activate
         */
        @ApiMethod(instanceRequired = true)
        public Boolean activate();

        /**
         * @see SoftLayer_User_Customer_External_Binding_Totp::deactivate
         */
        @ApiMethod(instanceRequired = true)
        public Boolean deactivate();

        /**
         * @see SoftLayer_User_Customer_External_Binding_Totp::generateSecretKey
         */
        @ApiMethod
        public String generateSecretKey();

        /**
         * @see SoftLayer_User_Customer_External_Binding_Totp::getObject
         */
        @ApiMethod(value = "getObject", instanceRequired = true)
        public Totp getObjectForTotp();

    }

    public static interface ServiceAsync extends Binding.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#activate}
         */
        public Future activate();

        public Future activate(ResponseHandler callback);

        /**
         * Async version of {@link Service#deactivate}
         */
        public Future deactivate();

        public Future deactivate(ResponseHandler callback);

        /**
         * Async version of {@link Service#generateSecretKey}
         */
        public Future generateSecretKey();

        public Future generateSecretKey(ResponseHandler callback);

        /**
         * Async version of {@link Service#getObjectForTotp}
         */
        public Future getObjectForTotp();

        public Future getObjectForTotp(ResponseHandler callback);

    }

    public static class Mask extends com.softlayer.api.service.user.customer.external.Binding.Mask {

    }

}