com.softlayer.api.service.user.customer.access.Authentication 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.access;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.user.Customer;
import java.util.GregorianCalendar;

/**
 * SoftLayer_User_Customer_Access_Authentication models a single attempt to log into the SoftLayer customer portal. A SoftLayer_User_Customer_Access_Authentication record is created every time a user attempts to log into the portal. Use this service to audit your users' portal activity and diagnose potential security breaches of your SoftLayer portal accounts. 

 * 

 * Unsuccessful login attempts can be caused by an incorrect password, failing to answer or not answering a login security question if the user has them configured, or attempting to log in from an IP address outside of the user's IP address restriction list. 

 * 

 * SoftLayer employees periodically log into our customer portal as users to diagnose portal issues, verify settings and configuration, and to perform maintenance on your account or services. SoftLayer employees only log into customer accounts from the following IP ranges: 

 * * 2607:f0d0:1000::/48

 * * 2607:f0d0:2000::/48

 * * 2607:f0d0:3000::/48

 * * 66.228.118.67/32

 * * 66.228.118.86/32
 *
 * @see SoftLayer_User_Customer_Access_Authentication
 */
@ApiType("SoftLayer_User_Customer_Access_Authentication")
public class Authentication extends Entity {

    /**
     * The user who has attempted to log into the SoftLayer customer portal.
     */
    @ApiProperty
    protected Customer user;

    public Customer getUser() {
        return user;
    }

    public void setUser(Customer user) {
        this.user = user;
    }

    /**
     * The date of an attempt to log into the SoftLayer customer portal.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar createDate;

    public GregorianCalendar getCreateDate() {
        return createDate;
    }

    public void setCreateDate(GregorianCalendar createDate) {
        createDateSpecified = true;
        this.createDate = createDate;
    }

    protected boolean createDateSpecified;

    public boolean isCreateDateSpecified() {
        return createDateSpecified;
    }

    public void unsetCreateDate() {
        createDate = null;
        createDateSpecified = false;
    }

    /**
     * The IP address of the user who attempted to log into the SoftLayer customer portal.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String ipAddress;

    public String getIpAddress() {
        return ipAddress;
    }

    public void setIpAddress(String ipAddress) {
        ipAddressSpecified = true;
        this.ipAddress = ipAddress;
    }

    protected boolean ipAddressSpecified;

    public boolean isIpAddressSpecified() {
        return ipAddressSpecified;
    }

    public void unsetIpAddress() {
        ipAddress = null;
        ipAddressSpecified = false;
    }

    /**
     * Whether an attempt to log into the SoftLayer customer portal was successful or not.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean successFlag;

    public Boolean getSuccessFlag() {
        return successFlag;
    }

    public void setSuccessFlag(Boolean successFlag) {
        successFlagSpecified = true;
        this.successFlag = successFlag;
    }

    protected boolean successFlagSpecified;

    public boolean isSuccessFlagSpecified() {
        return successFlagSpecified;
    }

    public void unsetSuccessFlag() {
        successFlag = null;
        successFlagSpecified = false;
    }

    /**
     * The internal identifier of the user who attempted to log into the SoftLayer customer portal.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long userId;

    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        userIdSpecified = true;
        this.userId = userId;
    }

    protected boolean userIdSpecified;

    public boolean isUserIdSpecified() {
        return userIdSpecified;
    }

    public void unsetUserId() {
        userId = null;
        userIdSpecified = false;
    }

    /**
     * The username used when attempting to log into the SoftLayer customer portal
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String username;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        usernameSpecified = true;
        this.username = username;
    }

    protected boolean usernameSpecified;

    public boolean isUsernameSpecified() {
        return usernameSpecified;
    }

    public void unsetUsername() {
        username = null;
        usernameSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public com.softlayer.api.service.user.Customer.Mask user() {
            return withSubMask("user", com.softlayer.api.service.user.Customer.Mask.class);
        }

        public Mask createDate() {
            withLocalProperty("createDate");
            return this;
        }

        public Mask ipAddress() {
            withLocalProperty("ipAddress");
            return this;
        }

        public Mask successFlag() {
            withLocalProperty("successFlag");
            return this;
        }

        public Mask userId() {
            withLocalProperty("userId");
            return this;
        }

        public Mask username() {
            withLocalProperty("username");
            return this;
        }

    }

}