com.softlayer.api.service.user.Customer 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
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service.user;
import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Locale;
import com.softlayer.api.service.Survey;
import com.softlayer.api.service.Ticket;
import com.softlayer.api.service.container.authentication.request.Contract;
import com.softlayer.api.service.container.authentication.response.Common;
import com.softlayer.api.service.container.user.authentication.Token;
import com.softlayer.api.service.container.user.customer.PasswordSet;
import com.softlayer.api.service.container.user.customer.external.binding.Vendor;
import com.softlayer.api.service.container.user.customer.openidconnect.MigrationState;
import com.softlayer.api.service.layout.Profile;
import com.softlayer.api.service.locale.Timezone;
import com.softlayer.api.service.network.service.vpn.Overrides;
import com.softlayer.api.service.notification.user.Subscriber;
import com.softlayer.api.service.user.Interface;
import com.softlayer.api.service.user.Preference;
import com.softlayer.api.service.user.customer.AdditionalEmail;
import com.softlayer.api.service.user.customer.ApiAuthentication;
import com.softlayer.api.service.user.customer.Link;
import com.softlayer.api.service.user.customer.MobileDevice;
import com.softlayer.api.service.user.customer.Status;
import com.softlayer.api.service.user.customer.access.Authentication;
import com.softlayer.api.service.user.customer.customerpermission.Permission;
import com.softlayer.api.service.user.customer.notification.Hardware;
import com.softlayer.api.service.user.customer.security.Answer;
import com.softlayer.api.service.user.external.Binding;
import com.softlayer.api.service.user.permission.Action;
import com.softlayer.api.service.user.permission.Role;
import com.softlayer.api.service.user.preference.Type;
import com.softlayer.api.service.user.security.Question;
import com.softlayer.api.service.virtual.DedicatedHost;
import com.softlayer.api.service.virtual.Guest;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;
/**
* The SoftLayer_User_Customer data type contains general information relating to a single SoftLayer customer portal user. Personal information in this type such as names, addresses, and phone numbers are not necessarily associated with the customer account the user is assigned to.
*
* @see SoftLayer_User_Customer
*/
@ApiType("SoftLayer_User_Customer")
public class Customer extends Interface {
/**
* The customer account that a user belongs to.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
@ApiProperty
protected List actions;
public List getActions() {
if (actions == null) {
actions = new ArrayList();
}
return actions;
}
/**
* A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
*/
@ApiProperty
protected List additionalEmails;
public List getAdditionalEmails() {
if (additionalEmails == null) {
additionalEmails = new ArrayList();
}
return additionalEmails;
}
/**
* A portal user's API Authentication keys. There is a max limit of two API keys per user.
*/
@ApiProperty
protected List apiAuthenticationKeys;
public List getApiAuthenticationKeys() {
if (apiAuthenticationKeys == null) {
apiAuthenticationKeys = new ArrayList();
}
return apiAuthenticationKeys;
}
/**
* The CDN accounts associated with a portal user.
*/
@ApiProperty
protected List cdnAccounts;
public List getCdnAccounts() {
if (cdnAccounts == null) {
cdnAccounts = new ArrayList();
}
return cdnAccounts;
}
/**
* A portal user's child users. Some portal users may not have child users.
*/
@ApiProperty
protected List childUsers;
public List getChildUsers() {
if (childUsers == null) {
childUsers = new ArrayList();
}
return childUsers;
}
/**
* An user's associated closed tickets.
*/
@ApiProperty
protected List closedTickets;
public List getClosedTickets() {
if (closedTickets == null) {
closedTickets = new ArrayList();
}
return closedTickets;
}
/**
* The dedicated hosts to which the user has been granted access.
*/
@ApiProperty
protected List dedicatedHosts;
public List getDedicatedHosts() {
if (dedicatedHosts == null) {
dedicatedHosts = new ArrayList();
}
return dedicatedHosts;
}
/**
* The external authentication bindings that link an external identifier to a SoftLayer user.
*/
@ApiProperty
protected List externalBindings;
public List getExternalBindings() {
if (externalBindings == null) {
externalBindings = new ArrayList();
}
return externalBindings;
}
/**
* A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.
*/
@ApiProperty
protected List hardware;
public List getHardware() {
if (hardware == null) {
hardware = new ArrayList();
}
return hardware;
}
/**
* Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'.
*/
@ApiProperty
protected List hardwareNotifications;
public List getHardwareNotifications() {
if (hardwareNotifications == null) {
hardwareNotifications = new ArrayList();
}
return hardwareNotifications;
}
/**
* Whether or not a user has acknowledged the support policy.
*/
@ApiProperty
protected Boolean hasAcknowledgedSupportPolicyFlag;
public Boolean getHasAcknowledgedSupportPolicyFlag() {
return hasAcknowledgedSupportPolicyFlag;
}
public void setHasAcknowledgedSupportPolicyFlag(Boolean hasAcknowledgedSupportPolicyFlag) {
this.hasAcknowledgedSupportPolicyFlag = hasAcknowledgedSupportPolicyFlag;
}
/**
* Permission granting the user access to all Dedicated Host devices on the account.
*/
@ApiProperty
protected Boolean hasFullDedicatedHostAccessFlag;
public Boolean getHasFullDedicatedHostAccessFlag() {
return hasFullDedicatedHostAccessFlag;
}
public void setHasFullDedicatedHostAccessFlag(Boolean hasFullDedicatedHostAccessFlag) {
this.hasFullDedicatedHostAccessFlag = hasFullDedicatedHostAccessFlag;
}
/**
* Whether or not a portal user has access to all hardware on their account.
*/
@ApiProperty
protected Boolean hasFullHardwareAccessFlag;
public Boolean getHasFullHardwareAccessFlag() {
return hasFullHardwareAccessFlag;
}
public void setHasFullHardwareAccessFlag(Boolean hasFullHardwareAccessFlag) {
this.hasFullHardwareAccessFlag = hasFullHardwareAccessFlag;
}
/**
* Whether or not a portal user has access to all hardware on their account.
*/
@ApiProperty
protected Boolean hasFullVirtualGuestAccessFlag;
public Boolean getHasFullVirtualGuestAccessFlag() {
return hasFullVirtualGuestAccessFlag;
}
public void setHasFullVirtualGuestAccessFlag(Boolean hasFullVirtualGuestAccessFlag) {
this.hasFullVirtualGuestAccessFlag = hasFullVirtualGuestAccessFlag;
}
@ApiProperty
protected Link ibmIdLink;
public Link getIbmIdLink() {
return ibmIdLink;
}
public void setIbmIdLink(Link ibmIdLink) {
this.ibmIdLink = ibmIdLink;
}
@ApiProperty
protected List layoutProfiles;
public List getLayoutProfiles() {
if (layoutProfiles == null) {
layoutProfiles = new ArrayList();
}
return layoutProfiles;
}
/**
* A user's locale. Locale holds user's language and region information.
*/
@ApiProperty
protected Locale locale;
public Locale getLocale() {
return locale;
}
public void setLocale(Locale locale) {
this.locale = locale;
}
/**
* A user's attempts to log into the SoftLayer customer portal.
*/
@ApiProperty
protected List loginAttempts;
public List getLoginAttempts() {
if (loginAttempts == null) {
loginAttempts = new ArrayList();
}
return loginAttempts;
}
/**
* A portal user's associated mobile device profiles.
*/
@ApiProperty
protected List mobileDevices;
public List getMobileDevices() {
if (mobileDevices == null) {
mobileDevices = new ArrayList();
}
return mobileDevices;
}
/**
* Notification subscription records for the user.
*/
@ApiProperty
protected List notificationSubscribers;
public List getNotificationSubscribers() {
if (notificationSubscribers == null) {
notificationSubscribers = new ArrayList();
}
return notificationSubscribers;
}
/**
* An user's associated open tickets.
*/
@ApiProperty
protected List openTickets;
public List getOpenTickets() {
if (openTickets == null) {
openTickets = new ArrayList();
}
return openTickets;
}
/**
* A portal user's vpn accessible subnets.
*/
@ApiProperty
protected List overrides;
public List getOverrides() {
if (overrides == null) {
overrides = new ArrayList();
}
return overrides;
}
/**
* A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.
*/
@ApiProperty
protected Customer parent;
public Customer getParent() {
return parent;
}
public void setParent(Customer parent) {
this.parent = parent;
}
/**
* A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.
*/
@ApiProperty
protected List permissions;
public List getPermissions() {
if (permissions == null) {
permissions = new ArrayList();
}
return permissions;
}
@ApiProperty
protected List preferences;
public List getPreferences() {
if (preferences == null) {
preferences = new ArrayList();
}
return preferences;
}
@ApiProperty
protected List roles;
public List getRoles() {
if (roles == null) {
roles = new ArrayList();
}
return roles;
}
@ApiProperty
protected Link salesforceUserLink;
public Link getSalesforceUserLink() {
return salesforceUserLink;
}
public void setSalesforceUserLink(Link salesforceUserLink) {
this.salesforceUserLink = salesforceUserLink;
}
/**
* A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login.
*/
@ApiProperty
protected List securityAnswers;
public List getSecurityAnswers() {
if (securityAnswers == null) {
securityAnswers = new ArrayList();
}
return securityAnswers;
}
/**
* A user's notification subscription records.
*/
@ApiProperty
protected List subscribers;
public List getSubscribers() {
if (subscribers == null) {
subscribers = new ArrayList();
}
return subscribers;
}
/**
* A user's successful attempts to log into the SoftLayer customer portal.
*/
@ApiProperty
protected List successfulLogins;
public List getSuccessfulLogins() {
if (successfulLogins == null) {
successfulLogins = new ArrayList();
}
return successfulLogins;
}
/**
* Whether or not a user is required to acknowledge the support policy for portal access.
*/
@ApiProperty
protected Long supportPolicyAcknowledgementRequiredFlag;
public Long getSupportPolicyAcknowledgementRequiredFlag() {
return supportPolicyAcknowledgementRequiredFlag;
}
public void setSupportPolicyAcknowledgementRequiredFlag(Long supportPolicyAcknowledgementRequiredFlag) {
this.supportPolicyAcknowledgementRequiredFlag = supportPolicyAcknowledgementRequiredFlag;
}
/**
* Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.
*/
@ApiProperty
protected Boolean surveyRequiredFlag;
public Boolean getSurveyRequiredFlag() {
return surveyRequiredFlag;
}
public void setSurveyRequiredFlag(Boolean surveyRequiredFlag) {
this.surveyRequiredFlag = surveyRequiredFlag;
}
/**
* The surveys that a user has taken in the SoftLayer customer portal.
*/
@ApiProperty
protected List surveys;
public List getSurveys() {
if (surveys == null) {
surveys = new ArrayList();
}
return surveys;
}
/**
* An user's associated tickets.
*/
@ApiProperty
protected List tickets;
public List getTickets() {
if (tickets == null) {
tickets = new ArrayList();
}
return tickets;
}
/**
* A portal user's time zone.
*/
@ApiProperty
protected Timezone timezone;
public Timezone getTimezone() {
return timezone;
}
public void setTimezone(Timezone timezone) {
this.timezone = timezone;
}
/**
* A user's unsuccessful attempts to log into the SoftLayer customer portal.
*/
@ApiProperty
protected List unsuccessfulLogins;
public List getUnsuccessfulLogins() {
if (unsuccessfulLogins == null) {
unsuccessfulLogins = new ArrayList();
}
return unsuccessfulLogins;
}
@ApiProperty
protected List userLinks;
public List getUserLinks() {
if (userLinks == null) {
userLinks = new ArrayList();
}
return userLinks;
}
/**
* A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.
*/
@ApiProperty
protected Status userStatus;
public Status getUserStatus() {
return userStatus;
}
public void setUserStatus(Status userStatus) {
this.userStatus = userStatus;
}
/**
* A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.
*/
@ApiProperty
protected List virtualGuests;
public List getVirtualGuests() {
if (virtualGuests == null) {
virtualGuests = new ArrayList();
}
return virtualGuests;
}
/**
* A portal user's associated [[SoftLayer_Account|customer account]] id.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long accountId;
public Long getAccountId() {
return accountId;
}
public void setAccountId(Long accountId) {
accountIdSpecified = true;
this.accountId = accountId;
}
protected boolean accountIdSpecified;
public boolean isAccountIdSpecified() {
return accountIdSpecified;
}
public void unsetAccountId() {
accountId = null;
accountIdSpecified = false;
}
/**
* The first line of the mailing address belonging to a portal user.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String address1;
public String getAddress1() {
return address1;
}
public void setAddress1(String address1) {
address1Specified = true;
this.address1 = address1;
}
protected boolean address1Specified;
public boolean isAddress1Specified() {
return address1Specified;
}
public void unsetAddress1() {
address1 = null;
address1Specified = false;
}
/**
* The second line of the mailing address belonging to a portal user.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String address2;
public String getAddress2() {
return address2;
}
public void setAddress2(String address2) {
address2Specified = true;
this.address2 = address2;
}
protected boolean address2Specified;
public boolean isAddress2Specified() {
return address2Specified;
}
public void unsetAddress2() {
address2 = null;
address2Specified = false;
}
/**
* A portal user's AOL Instant Messenger screen name.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String aim;
public String getAim() {
return aim;
}
public void setAim(String aim) {
aimSpecified = true;
this.aim = aim;
}
protected boolean aimSpecified;
public boolean isAimSpecified() {
return aimSpecified;
}
public void unsetAim() {
aim = null;
aimSpecified = false;
}
/**
* A portal user's secondary phone number.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String alternatePhone;
public String getAlternatePhone() {
return alternatePhone;
}
public void setAlternatePhone(String alternatePhone) {
alternatePhoneSpecified = true;
this.alternatePhone = alternatePhone;
}
protected boolean alternatePhoneSpecified;
public boolean isAlternatePhoneSpecified() {
return alternatePhoneSpecified;
}
public void unsetAlternatePhone() {
alternatePhone = null;
alternatePhoneSpecified = false;
}
/**
* The authentication token used for logging into the SoftLayer customer portal.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Token authenticationToken;
public Token getAuthenticationToken() {
return authenticationToken;
}
public void setAuthenticationToken(Token authenticationToken) {
authenticationTokenSpecified = true;
this.authenticationToken = authenticationToken;
}
protected boolean authenticationTokenSpecified;
public boolean isAuthenticationTokenSpecified() {
return authenticationTokenSpecified;
}
public void unsetAuthenticationToken() {
authenticationToken = null;
authenticationTokenSpecified = false;
}
/**
* The city of the mailing address belonging to a portal user.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String city;
public String getCity() {
return city;
}
public void setCity(String city) {
citySpecified = true;
this.city = city;
}
protected boolean citySpecified;
public boolean isCitySpecified() {
return citySpecified;
}
public void unsetCity() {
city = null;
citySpecified = false;
}
/**
* A portal user's associated company. This may not be the same company as the customer that owns this portal user.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String companyName;
public String getCompanyName() {
return companyName;
}
public void setCompanyName(String companyName) {
companyNameSpecified = true;
this.companyName = companyName;
}
protected boolean companyNameSpecified;
public boolean isCompanyNameSpecified() {
return companyNameSpecified;
}
public void unsetCompanyName() {
companyName = null;
companyNameSpecified = false;
}
/**
* A two-letter abbreviation of the country in the mailing address belonging to a portal user.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String country;
public String getCountry() {
return country;
}
public void setCountry(String country) {
countrySpecified = true;
this.country = country;
}
protected boolean countrySpecified;
public boolean isCountrySpecified() {
return countrySpecified;
}
public void unsetCountry() {
country = null;
countrySpecified = false;
}
/**
* The date a portal user's record was created.
*/
@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;
}
/**
* Whether a portal user's time zone is affected by Daylight Savings Time.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean daylightSavingsTimeFlag;
public Boolean getDaylightSavingsTimeFlag() {
return daylightSavingsTimeFlag;
}
public void setDaylightSavingsTimeFlag(Boolean daylightSavingsTimeFlag) {
daylightSavingsTimeFlagSpecified = true;
this.daylightSavingsTimeFlag = daylightSavingsTimeFlag;
}
protected boolean daylightSavingsTimeFlagSpecified;
public boolean isDaylightSavingsTimeFlagSpecified() {
return daylightSavingsTimeFlagSpecified;
}
public void unsetDaylightSavingsTimeFlag() {
daylightSavingsTimeFlag = null;
daylightSavingsTimeFlagSpecified = false;
}
/**
* Flag used to deny access to all hardware and cloud computing instances upon user creation.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean denyAllResourceAccessOnCreateFlag;
public Boolean getDenyAllResourceAccessOnCreateFlag() {
return denyAllResourceAccessOnCreateFlag;
}
public void setDenyAllResourceAccessOnCreateFlag(Boolean denyAllResourceAccessOnCreateFlag) {
denyAllResourceAccessOnCreateFlagSpecified = true;
this.denyAllResourceAccessOnCreateFlag = denyAllResourceAccessOnCreateFlag;
}
protected boolean denyAllResourceAccessOnCreateFlagSpecified;
public boolean isDenyAllResourceAccessOnCreateFlagSpecified() {
return denyAllResourceAccessOnCreateFlagSpecified;
}
public void unsetDenyAllResourceAccessOnCreateFlag() {
denyAllResourceAccessOnCreateFlag = null;
denyAllResourceAccessOnCreateFlagSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected String displayName;
public String getDisplayName() {
return displayName;
}
public void setDisplayName(String displayName) {
displayNameSpecified = true;
this.displayName = displayName;
}
protected boolean displayNameSpecified;
public boolean isDisplayNameSpecified() {
return displayNameSpecified;
}
public void unsetDisplayName() {
displayName = null;
displayNameSpecified = false;
}
/**
* A portal user's email address.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String email;
public String getEmail() {
return email;
}
public void setEmail(String email) {
emailSpecified = true;
this.email = email;
}
protected boolean emailSpecified;
public boolean isEmailSpecified() {
return emailSpecified;
}
public void unsetEmail() {
email = null;
emailSpecified = false;
}
/**
* A portal user's first name.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String firstName;
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
firstNameSpecified = true;
this.firstName = firstName;
}
protected boolean firstNameSpecified;
public boolean isFirstNameSpecified() {
return firstNameSpecified;
}
public void unsetFirstName() {
firstName = null;
firstNameSpecified = false;
}
/**
* A user's password for the SoftLayer forums, hashed for auto-login capability from the SoftLayer customer portal
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String forumPasswordHash;
public String getForumPasswordHash() {
return forumPasswordHash;
}
public void setForumPasswordHash(String forumPasswordHash) {
forumPasswordHashSpecified = true;
this.forumPasswordHash = forumPasswordHash;
}
protected boolean forumPasswordHashSpecified;
public boolean isForumPasswordHashSpecified() {
return forumPasswordHashSpecified;
}
public void unsetForumPasswordHash() {
forumPasswordHash = null;
forumPasswordHashSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected Long iamAuthorizationStatus;
public Long getIamAuthorizationStatus() {
return iamAuthorizationStatus;
}
public void setIamAuthorizationStatus(Long iamAuthorizationStatus) {
iamAuthorizationStatusSpecified = true;
this.iamAuthorizationStatus = iamAuthorizationStatus;
}
protected boolean iamAuthorizationStatusSpecified;
public boolean isIamAuthorizationStatusSpecified() {
return iamAuthorizationStatusSpecified;
}
public void unsetIamAuthorizationStatus() {
iamAuthorizationStatus = null;
iamAuthorizationStatusSpecified = false;
}
/**
* The IAMid (realm-identifier) of the user being created by PaaS
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String iamId;
public String getIamId() {
return iamId;
}
public void setIamId(String iamId) {
iamIdSpecified = true;
this.iamId = iamId;
}
protected boolean iamIdSpecified;
public boolean isIamIdSpecified() {
return iamIdSpecified;
}
public void unsetIamId() {
iamId = null;
iamIdSpecified = false;
}
/**
* A portal user's ICQ UIN.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String icq;
public String getIcq() {
return icq;
}
public void setIcq(String icq) {
icqSpecified = true;
this.icq = icq;
}
protected boolean icqSpecified;
public boolean isIcqSpecified() {
return icqSpecified;
}
public void unsetIcq() {
icq = null;
icqSpecified = false;
}
/**
* A portal user's internal identifying number.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long id;
public Long getId() {
return id;
}
public void setId(Long id) {
idSpecified = true;
this.id = id;
}
protected boolean idSpecified;
public boolean isIdSpecified() {
return idSpecified;
}
public void unsetId() {
id = null;
idSpecified = false;
}
/**
* The IP addresses or IP ranges from which a user may login to the SoftLayer customer portal. Specify subnets in CIDR format and separate multiple addresses and subnets by commas. You may combine IPv4 and IPv6 addresses and subnets, for example: 192.168.0.0/16,fe80:021b::0/64.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String ipAddressRestriction;
public String getIpAddressRestriction() {
return ipAddressRestriction;
}
public void setIpAddressRestriction(String ipAddressRestriction) {
ipAddressRestrictionSpecified = true;
this.ipAddressRestriction = ipAddressRestriction;
}
protected boolean ipAddressRestrictionSpecified;
public boolean isIpAddressRestrictionSpecified() {
return ipAddressRestrictionSpecified;
}
public void unsetIpAddressRestriction() {
ipAddressRestriction = null;
ipAddressRestrictionSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean isMasterUserFlag;
public Boolean getIsMasterUserFlag() {
return isMasterUserFlag;
}
public void setIsMasterUserFlag(Boolean isMasterUserFlag) {
isMasterUserFlagSpecified = true;
this.isMasterUserFlag = isMasterUserFlag;
}
protected boolean isMasterUserFlagSpecified;
public boolean isIsMasterUserFlagSpecified() {
return isMasterUserFlagSpecified;
}
public void unsetIsMasterUserFlag() {
isMasterUserFlag = null;
isMasterUserFlagSpecified = false;
}
/**
* A portal user's last name.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String lastName;
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
lastNameSpecified = true;
this.lastName = lastName;
}
protected boolean lastNameSpecified;
public boolean isLastNameSpecified() {
return lastNameSpecified;
}
public void unsetLastName() {
lastName = null;
lastNameSpecified = false;
}
/**
* The linked account integration mode
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String linkedAccountIntegrationMode;
public String getLinkedAccountIntegrationMode() {
return linkedAccountIntegrationMode;
}
public void setLinkedAccountIntegrationMode(String linkedAccountIntegrationMode) {
linkedAccountIntegrationModeSpecified = true;
this.linkedAccountIntegrationMode = linkedAccountIntegrationMode;
}
protected boolean linkedAccountIntegrationModeSpecified;
public boolean isLinkedAccountIntegrationModeSpecified() {
return linkedAccountIntegrationModeSpecified;
}
public void unsetLinkedAccountIntegrationMode() {
linkedAccountIntegrationMode = null;
linkedAccountIntegrationModeSpecified = false;
}
/**
* A portal user's associated [[SoftLayer_Locale|locale]] id.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long localeId;
public Long getLocaleId() {
return localeId;
}
public void setLocaleId(Long localeId) {
localeIdSpecified = true;
this.localeId = localeId;
}
protected boolean localeIdSpecified;
public boolean isLocaleIdSpecified() {
return localeIdSpecified;
}
public void unsetLocaleId() {
localeId = null;
localeIdSpecified = false;
}
/**
* Determines if this portal user is managed by SAML federation.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean managedByFederationFlag;
public Boolean getManagedByFederationFlag() {
return managedByFederationFlag;
}
public void setManagedByFederationFlag(Boolean managedByFederationFlag) {
managedByFederationFlagSpecified = true;
this.managedByFederationFlag = managedByFederationFlag;
}
protected boolean managedByFederationFlagSpecified;
public boolean isManagedByFederationFlagSpecified() {
return managedByFederationFlagSpecified;
}
public void unsetManagedByFederationFlag() {
managedByFederationFlag = null;
managedByFederationFlagSpecified = false;
}
/**
* Determines if this portal user is managed by IBMid federation.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean managedByOpenIdConnectFlag;
public Boolean getManagedByOpenIdConnectFlag() {
return managedByOpenIdConnectFlag;
}
public void setManagedByOpenIdConnectFlag(Boolean managedByOpenIdConnectFlag) {
managedByOpenIdConnectFlagSpecified = true;
this.managedByOpenIdConnectFlag = managedByOpenIdConnectFlag;
}
protected boolean managedByOpenIdConnectFlagSpecified;
public boolean isManagedByOpenIdConnectFlagSpecified() {
return managedByOpenIdConnectFlagSpecified;
}
public void unsetManagedByOpenIdConnectFlag() {
managedByOpenIdConnectFlag = null;
managedByOpenIdConnectFlagSpecified = false;
}
/**
* The date a portal user's record was last modified.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar modifyDate;
public GregorianCalendar getModifyDate() {
return modifyDate;
}
public void setModifyDate(GregorianCalendar modifyDate) {
modifyDateSpecified = true;
this.modifyDate = modifyDate;
}
protected boolean modifyDateSpecified;
public boolean isModifyDateSpecified() {
return modifyDateSpecified;
}
public void unsetModifyDate() {
modifyDate = null;
modifyDateSpecified = false;
}
/**
* A portal user's MSN address.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String msn;
public String getMsn() {
return msn;
}
public void setMsn(String msn) {
msnSpecified = true;
this.msn = msn;
}
protected boolean msnSpecified;
public boolean isMsnSpecified() {
return msnSpecified;
}
public void unsetMsn() {
msn = null;
msnSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected String nameId;
public String getNameId() {
return nameId;
}
public void setNameId(String nameId) {
nameIdSpecified = true;
this.nameId = nameId;
}
protected boolean nameIdSpecified;
public boolean isNameIdSpecified() {
return nameIdSpecified;
}
public void unsetNameId() {
nameId = null;
nameIdSpecified = false;
}
/**
* A portal user's office phone number.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String officePhone;
public String getOfficePhone() {
return officePhone;
}
public void setOfficePhone(String officePhone) {
officePhoneSpecified = true;
this.officePhone = officePhone;
}
protected boolean officePhoneSpecified;
public boolean isOfficePhoneSpecified() {
return officePhoneSpecified;
}
public void unsetOfficePhone() {
officePhone = null;
officePhoneSpecified = false;
}
/**
* The BlueID username associated to with this user, if the account is managed by OpenIDConnect / BlueID federation
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String openIdConnectUserName;
public String getOpenIdConnectUserName() {
return openIdConnectUserName;
}
public void setOpenIdConnectUserName(String openIdConnectUserName) {
openIdConnectUserNameSpecified = true;
this.openIdConnectUserName = openIdConnectUserName;
}
protected boolean openIdConnectUserNameSpecified;
public boolean isOpenIdConnectUserNameSpecified() {
return openIdConnectUserNameSpecified;
}
public void unsetOpenIdConnectUserName() {
openIdConnectUserName = null;
openIdConnectUserNameSpecified = false;
}
/**
* A portal user's parent user. Id a users parentId is ''null'' then it doesn't have a parent user in the customer portal.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long parentId;
public Long getParentId() {
return parentId;
}
public void setParentId(Long parentId) {
parentIdSpecified = true;
this.parentId = parentId;
}
protected boolean parentIdSpecified;
public boolean isParentIdSpecified() {
return parentIdSpecified;
}
public void unsetParentId() {
parentId = null;
parentIdSpecified = false;
}
/**
* The expiration date for the user's password
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar passwordExpireDate;
public GregorianCalendar getPasswordExpireDate() {
return passwordExpireDate;
}
public void setPasswordExpireDate(GregorianCalendar passwordExpireDate) {
passwordExpireDateSpecified = true;
this.passwordExpireDate = passwordExpireDate;
}
protected boolean passwordExpireDateSpecified;
public boolean isPasswordExpireDateSpecified() {
return passwordExpireDateSpecified;
}
public void unsetPasswordExpireDate() {
passwordExpireDate = null;
passwordExpireDateSpecified = false;
}
/**
* The postal code of the mailing address belonging to an portal user.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String postalCode;
public String getPostalCode() {
return postalCode;
}
public void setPostalCode(String postalCode) {
postalCodeSpecified = true;
this.postalCode = postalCode;
}
protected boolean postalCodeSpecified;
public boolean isPostalCodeSpecified() {
return postalCodeSpecified;
}
public void unsetPostalCode() {
postalCode = null;
postalCodeSpecified = false;
}
/**
* Whether a portal user may connect to the SoftLayer private network via PPTP VPN or not.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean pptpVpnAllowedFlag;
public Boolean getPptpVpnAllowedFlag() {
return pptpVpnAllowedFlag;
}
public void setPptpVpnAllowedFlag(Boolean pptpVpnAllowedFlag) {
pptpVpnAllowedFlagSpecified = true;
this.pptpVpnAllowedFlag = pptpVpnAllowedFlag;
}
protected boolean pptpVpnAllowedFlagSpecified;
public boolean isPptpVpnAllowedFlagSpecified() {
return pptpVpnAllowedFlagSpecified;
}
public void unsetPptpVpnAllowedFlag() {
pptpVpnAllowedFlag = null;
pptpVpnAllowedFlagSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected String savedId;
public String getSavedId() {
return savedId;
}
public void setSavedId(String savedId) {
savedIdSpecified = true;
this.savedId = savedId;
}
protected boolean savedIdSpecified;
public boolean isSavedIdSpecified() {
return savedIdSpecified;
}
public void unsetSavedId() {
savedId = null;
savedIdSpecified = false;
}
/**
* Whether a user may change their security options (IP restriction, password expiration, or enforce security questions on login) which were pre-selected by their account's master user.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean secondaryLoginManagementFlag;
public Boolean getSecondaryLoginManagementFlag() {
return secondaryLoginManagementFlag;
}
public void setSecondaryLoginManagementFlag(Boolean secondaryLoginManagementFlag) {
secondaryLoginManagementFlagSpecified = true;
this.secondaryLoginManagementFlag = secondaryLoginManagementFlag;
}
protected boolean secondaryLoginManagementFlagSpecified;
public boolean isSecondaryLoginManagementFlagSpecified() {
return secondaryLoginManagementFlagSpecified;
}
public void unsetSecondaryLoginManagementFlag() {
secondaryLoginManagementFlag = null;
secondaryLoginManagementFlagSpecified = false;
}
/**
* Whether a user is required to answer a security question when logging into the SoftLayer customer portal.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean secondaryLoginRequiredFlag;
public Boolean getSecondaryLoginRequiredFlag() {
return secondaryLoginRequiredFlag;
}
public void setSecondaryLoginRequiredFlag(Boolean secondaryLoginRequiredFlag) {
secondaryLoginRequiredFlagSpecified = true;
this.secondaryLoginRequiredFlag = secondaryLoginRequiredFlag;
}
protected boolean secondaryLoginRequiredFlagSpecified;
public boolean isSecondaryLoginRequiredFlagSpecified() {
return secondaryLoginRequiredFlagSpecified;
}
public void unsetSecondaryLoginRequiredFlag() {
secondaryLoginRequiredFlag = null;
secondaryLoginRequiredFlagSpecified = false;
}
/**
* The date when a user's password was last updated.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar secondaryPasswordModifyDate;
public GregorianCalendar getSecondaryPasswordModifyDate() {
return secondaryPasswordModifyDate;
}
public void setSecondaryPasswordModifyDate(GregorianCalendar secondaryPasswordModifyDate) {
secondaryPasswordModifyDateSpecified = true;
this.secondaryPasswordModifyDate = secondaryPasswordModifyDate;
}
protected boolean secondaryPasswordModifyDateSpecified;
public boolean isSecondaryPasswordModifyDateSpecified() {
return secondaryPasswordModifyDateSpecified;
}
public void unsetSecondaryPasswordModifyDate() {
secondaryPasswordModifyDate = null;
secondaryPasswordModifyDateSpecified = false;
}
/**
* The number of days for which a user's password is active.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long secondaryPasswordTimeoutDays;
public Long getSecondaryPasswordTimeoutDays() {
return secondaryPasswordTimeoutDays;
}
public void setSecondaryPasswordTimeoutDays(Long secondaryPasswordTimeoutDays) {
secondaryPasswordTimeoutDaysSpecified = true;
this.secondaryPasswordTimeoutDays = secondaryPasswordTimeoutDays;
}
protected boolean secondaryPasswordTimeoutDaysSpecified;
public boolean isSecondaryPasswordTimeoutDaysSpecified() {
return secondaryPasswordTimeoutDaysSpecified;
}
public void unsetSecondaryPasswordTimeoutDays() {
secondaryPasswordTimeoutDays = null;
secondaryPasswordTimeoutDaysSpecified = false;
}
/**
* A phone number that can receive SMS text messages for this portal user.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String sms;
public String getSms() {
return sms;
}
public void setSms(String sms) {
smsSpecified = true;
this.sms = sms;
}
protected boolean smsSpecified;
public boolean isSmsSpecified() {
return smsSpecified;
}
public void unsetSms() {
sms = null;
smsSpecified = false;
}
/**
* Whether a portal user may connect to the SoftLayer private network via SSL VPN or not.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean sslVpnAllowedFlag;
public Boolean getSslVpnAllowedFlag() {
return sslVpnAllowedFlag;
}
public void setSslVpnAllowedFlag(Boolean sslVpnAllowedFlag) {
sslVpnAllowedFlagSpecified = true;
this.sslVpnAllowedFlag = sslVpnAllowedFlag;
}
protected boolean sslVpnAllowedFlagSpecified;
public boolean isSslVpnAllowedFlagSpecified() {
return sslVpnAllowedFlagSpecified;
}
public void unsetSslVpnAllowedFlag() {
sslVpnAllowedFlag = null;
sslVpnAllowedFlagSpecified = false;
}
/**
* A two-letter abbreviation of the state in the mailing address belonging to a portal user. If a user does not reside in a province then this is typically blank.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String state;
public String getState() {
return state;
}
public void setState(String state) {
stateSpecified = true;
this.state = state;
}
protected boolean stateSpecified;
public boolean isStateSpecified() {
return stateSpecified;
}
public void unsetState() {
state = null;
stateSpecified = false;
}
/**
* The date a portal users record's last status change.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar statusDate;
public GregorianCalendar getStatusDate() {
return statusDate;
}
public void setStatusDate(GregorianCalendar statusDate) {
statusDateSpecified = true;
this.statusDate = statusDate;
}
protected boolean statusDateSpecified;
public boolean isStatusDateSpecified() {
return statusDateSpecified;
}
public void unsetStatusDate() {
statusDate = null;
statusDateSpecified = false;
}
/**
* A portal user's time zone.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long timezoneId;
public Long getTimezoneId() {
return timezoneId;
}
public void setTimezoneId(Long timezoneId) {
timezoneIdSpecified = true;
this.timezoneId = timezoneId;
}
protected boolean timezoneIdSpecified;
public boolean isTimezoneIdSpecified() {
return timezoneIdSpecified;
}
public void unsetTimezoneId() {
timezoneId = null;
timezoneIdSpecified = false;
}
/**
* A number reflecting the state of a portal user.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long userStatusId;
public Long getUserStatusId() {
return userStatusId;
}
public void setUserStatusId(Long userStatusId) {
userStatusIdSpecified = true;
this.userStatusId = userStatusId;
}
protected boolean userStatusIdSpecified;
public boolean isUserStatusIdSpecified() {
return userStatusIdSpecified;
}
public void unsetUserStatusId() {
userStatusId = null;
userStatusIdSpecified = false;
}
/**
* A portal user's username.
*/
@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;
}
/**
* The verification code from Bluemix BSS to save in the invitation
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String verificationCode;
public String getVerificationCode() {
return verificationCode;
}
public void setVerificationCode(String verificationCode) {
verificationCodeSpecified = true;
this.verificationCode = verificationCode;
}
protected boolean verificationCodeSpecified;
public boolean isVerificationCodeSpecified() {
return verificationCodeSpecified;
}
public void unsetVerificationCode() {
verificationCode = null;
verificationCodeSpecified = false;
}
/**
* Whether a portal user vpn subnets have been manual configured.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean vpnManualConfig;
public Boolean getVpnManualConfig() {
return vpnManualConfig;
}
public void setVpnManualConfig(Boolean vpnManualConfig) {
vpnManualConfigSpecified = true;
this.vpnManualConfig = vpnManualConfig;
}
protected boolean vpnManualConfigSpecified;
public boolean isVpnManualConfigSpecified() {
return vpnManualConfigSpecified;
}
public void unsetVpnManualConfig() {
vpnManualConfig = null;
vpnManualConfigSpecified = false;
}
/**
* A portal user's Yahoo! Chat name.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String yahoo;
public String getYahoo() {
return yahoo;
}
public void setYahoo(String yahoo) {
yahooSpecified = true;
this.yahoo = yahoo;
}
protected boolean yahooSpecified;
public boolean isYahooSpecified() {
return yahooSpecified;
}
public void unsetYahoo() {
yahoo = null;
yahooSpecified = false;
}
/**
* A count of
*/
@ApiProperty
protected Long actionCount;
public Long getActionCount() {
return actionCount;
}
public void setActionCount(Long actionCount) {
this.actionCount = actionCount;
}
/**
* A count of a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
*/
@ApiProperty
protected Long additionalEmailCount;
public Long getAdditionalEmailCount() {
return additionalEmailCount;
}
public void setAdditionalEmailCount(Long additionalEmailCount) {
this.additionalEmailCount = additionalEmailCount;
}
/**
* A count of a portal user's API Authentication keys. There is a max limit of two API keys per user.
*/
@ApiProperty
protected Long apiAuthenticationKeyCount;
public Long getApiAuthenticationKeyCount() {
return apiAuthenticationKeyCount;
}
public void setApiAuthenticationKeyCount(Long apiAuthenticationKeyCount) {
this.apiAuthenticationKeyCount = apiAuthenticationKeyCount;
}
/**
* A count of the CDN accounts associated with a portal user.
*/
@ApiProperty
protected Long cdnAccountCount;
public Long getCdnAccountCount() {
return cdnAccountCount;
}
public void setCdnAccountCount(Long cdnAccountCount) {
this.cdnAccountCount = cdnAccountCount;
}
/**
* A count of a portal user's child users. Some portal users may not have child users.
*/
@ApiProperty
protected Long childUserCount;
public Long getChildUserCount() {
return childUserCount;
}
public void setChildUserCount(Long childUserCount) {
this.childUserCount = childUserCount;
}
/**
* A count of an user's associated closed tickets.
*/
@ApiProperty
protected Long closedTicketCount;
public Long getClosedTicketCount() {
return closedTicketCount;
}
public void setClosedTicketCount(Long closedTicketCount) {
this.closedTicketCount = closedTicketCount;
}
/**
* A count of the dedicated hosts to which the user has been granted access.
*/
@ApiProperty
protected Long dedicatedHostCount;
public Long getDedicatedHostCount() {
return dedicatedHostCount;
}
public void setDedicatedHostCount(Long dedicatedHostCount) {
this.dedicatedHostCount = dedicatedHostCount;
}
/**
* A count of the external authentication bindings that link an external identifier to a SoftLayer user.
*/
@ApiProperty
protected Long externalBindingCount;
public Long getExternalBindingCount() {
return externalBindingCount;
}
public void setExternalBindingCount(Long externalBindingCount) {
this.externalBindingCount = externalBindingCount;
}
/**
* A count of a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.
*/
@ApiProperty
protected Long hardwareCount;
public Long getHardwareCount() {
return hardwareCount;
}
public void setHardwareCount(Long hardwareCount) {
this.hardwareCount = hardwareCount;
}
/**
* A count of hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'.
*/
@ApiProperty
protected Long hardwareNotificationCount;
public Long getHardwareNotificationCount() {
return hardwareNotificationCount;
}
public void setHardwareNotificationCount(Long hardwareNotificationCount) {
this.hardwareNotificationCount = hardwareNotificationCount;
}
/**
* A count of
*/
@ApiProperty
protected Long layoutProfileCount;
public Long getLayoutProfileCount() {
return layoutProfileCount;
}
public void setLayoutProfileCount(Long layoutProfileCount) {
this.layoutProfileCount = layoutProfileCount;
}
/**
* A count of a user's attempts to log into the SoftLayer customer portal.
*/
@ApiProperty
protected Long loginAttemptCount;
public Long getLoginAttemptCount() {
return loginAttemptCount;
}
public void setLoginAttemptCount(Long loginAttemptCount) {
this.loginAttemptCount = loginAttemptCount;
}
/**
* A count of a portal user's associated mobile device profiles.
*/
@ApiProperty
protected Long mobileDeviceCount;
public Long getMobileDeviceCount() {
return mobileDeviceCount;
}
public void setMobileDeviceCount(Long mobileDeviceCount) {
this.mobileDeviceCount = mobileDeviceCount;
}
/**
* A count of notification subscription records for the user.
*/
@ApiProperty
protected Long notificationSubscriberCount;
public Long getNotificationSubscriberCount() {
return notificationSubscriberCount;
}
public void setNotificationSubscriberCount(Long notificationSubscriberCount) {
this.notificationSubscriberCount = notificationSubscriberCount;
}
/**
* A count of an user's associated open tickets.
*/
@ApiProperty
protected Long openTicketCount;
public Long getOpenTicketCount() {
return openTicketCount;
}
public void setOpenTicketCount(Long openTicketCount) {
this.openTicketCount = openTicketCount;
}
/**
* A count of a portal user's vpn accessible subnets.
*/
@ApiProperty
protected Long overrideCount;
public Long getOverrideCount() {
return overrideCount;
}
public void setOverrideCount(Long overrideCount) {
this.overrideCount = overrideCount;
}
/**
* A count of a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.
*/
@ApiProperty
protected Long permissionCount;
public Long getPermissionCount() {
return permissionCount;
}
public void setPermissionCount(Long permissionCount) {
this.permissionCount = permissionCount;
}
/**
* A count of
*/
@ApiProperty
protected Long preferenceCount;
public Long getPreferenceCount() {
return preferenceCount;
}
public void setPreferenceCount(Long preferenceCount) {
this.preferenceCount = preferenceCount;
}
/**
* A count of
*/
@ApiProperty
protected Long roleCount;
public Long getRoleCount() {
return roleCount;
}
public void setRoleCount(Long roleCount) {
this.roleCount = roleCount;
}
/**
* A count of a portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login.
*/
@ApiProperty
protected Long securityAnswerCount;
public Long getSecurityAnswerCount() {
return securityAnswerCount;
}
public void setSecurityAnswerCount(Long securityAnswerCount) {
this.securityAnswerCount = securityAnswerCount;
}
/**
* A count of a user's notification subscription records.
*/
@ApiProperty
protected Long subscriberCount;
public Long getSubscriberCount() {
return subscriberCount;
}
public void setSubscriberCount(Long subscriberCount) {
this.subscriberCount = subscriberCount;
}
/**
* A count of a user's successful attempts to log into the SoftLayer customer portal.
*/
@ApiProperty
protected Long successfulLoginCount;
public Long getSuccessfulLoginCount() {
return successfulLoginCount;
}
public void setSuccessfulLoginCount(Long successfulLoginCount) {
this.successfulLoginCount = successfulLoginCount;
}
/**
* A count of the surveys that a user has taken in the SoftLayer customer portal.
*/
@ApiProperty
protected Long surveyCount;
public Long getSurveyCount() {
return surveyCount;
}
public void setSurveyCount(Long surveyCount) {
this.surveyCount = surveyCount;
}
/**
* A count of an user's associated tickets.
*/
@ApiProperty
protected Long ticketCount;
public Long getTicketCount() {
return ticketCount;
}
public void setTicketCount(Long ticketCount) {
this.ticketCount = ticketCount;
}
/**
* A count of a user's unsuccessful attempts to log into the SoftLayer customer portal.
*/
@ApiProperty
protected Long unsuccessfulLoginCount;
public Long getUnsuccessfulLoginCount() {
return unsuccessfulLoginCount;
}
public void setUnsuccessfulLoginCount(Long unsuccessfulLoginCount) {
this.unsuccessfulLoginCount = unsuccessfulLoginCount;
}
/**
* A count of
*/
@ApiProperty
protected Long userLinkCount;
public Long getUserLinkCount() {
return userLinkCount;
}
public void setUserLinkCount(Long userLinkCount) {
this.userLinkCount = userLinkCount;
}
/**
* A count of a portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.
*/
@ApiProperty
protected Long virtualGuestCount;
public Long getVirtualGuestCount() {
return virtualGuestCount;
}
public void setVirtualGuestCount(Long virtualGuestCount) {
this.virtualGuestCount = virtualGuestCount;
}
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());
}
/**
* Every SoftLayer account has one or more portal users which are defined by the SoftLayer_User_Customer service. Every SoftLayer customer account has a master user account whose name corresponds to their account id preceded by the letters "SL". Users exist in a parent-child relationship. Child users inherit the properties and permissions of their parent user while conversely a user may have more than one child users.
*
* API users have full access to their own portal user account and they could also have access to other users under their SoftLayer customer account, if they have "Manage Users" permission in the customer portal.
*
* @see SoftLayer_User_Customer
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_User_Customer")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* @see SoftLayer_User_Customer::acknowledgeSupportPolicy
*/
@ApiMethod(instanceRequired = true)
public Void acknowledgeSupportPolicy();
/**
* Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key.
*
* @see SoftLayer_User_Customer::addApiAuthenticationKey
*/
@ApiMethod(instanceRequired = true)
public String addApiAuthenticationKey();
/**
* Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then "not found" exceptions are thrown if the user attempts to access any of these devices.
*
* Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
*
* @see SoftLayer_User_Customer::addBulkDedicatedHostAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean addBulkDedicatedHostAccess(List dedicatedHostIds);
/**
* Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object.
*
* Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
*
* @see SoftLayer_User_Customer::addBulkHardwareAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean addBulkHardwareAccess(List hardwareIds);
/**
* Add multiple permissions to a portal user's permission set. [[Permissions]] control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user.
*
* Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.
*
* Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
*
* @see SoftLayer_User_Customer::addBulkPortalPermission
*/
@ApiMethod(instanceRequired = true)
public Boolean addBulkPortalPermission(List permissions);
/**
* @see SoftLayer_User_Customer::addBulkRoles
*/
@ApiMethod(instanceRequired = true)
public Void addBulkRoles(List roles);
/**
* Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object.
*
* Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.
*
* @see SoftLayer_User_Customer::addBulkVirtualGuestAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean addBulkVirtualGuestAccess(List virtualGuestIds);
/**
* Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then "not found" exceptions are thrown if the user attempts to access any of these devices.
*
* Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
*
* @see SoftLayer_User_Customer::addDedicatedHostAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean addDedicatedHostAccess(Long dedicatedHostId);
/**
* @see SoftLayer_User_Customer::addExternalBinding
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.user.customer.external.Binding addExternalBinding(Binding externalBinding);
/**
* Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true.
*
* Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
*
* @see SoftLayer_User_Customer::addHardwareAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean addHardwareAccess(Long hardwareId);
/**
* Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive.
*
* @see SoftLayer_User_Customer::addNotificationSubscriber
*/
@ApiMethod(instanceRequired = true)
public Boolean addNotificationSubscriber(String notificationKeyName);
/**
* Add a permission to a portal user's permission set. [[Permissions]] control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true.
*
* Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.
*
* Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter.
*
* @see SoftLayer_User_Customer::addPortalPermission
*/
@ApiMethod(instanceRequired = true)
public Boolean addPortalPermission(Permission permission);
/**
* @see SoftLayer_User_Customer::addRole
*/
@ApiMethod(instanceRequired = true)
public Void addRole(Role role);
/**
* Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true.
*
* Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.
*
* @see SoftLayer_User_Customer::addVirtualGuestAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean addVirtualGuestAccess(Long virtualGuestId);
/**
* This method can be used in place of [[SoftLayer_User_Customer::editObject]] to change the parent user of this user.
*
* The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent.
*
* If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess.
*
* @see SoftLayer_User_Customer::assignNewParentId
*/
@ApiMethod(instanceRequired = true)
public Customer assignNewParentId(Long parentId, Boolean cascadePermissionsFlag);
/**
* Select a type of preference you would like to modify using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.
*
* @see SoftLayer_User_Customer::changePreference
*/
@ApiMethod(instanceRequired = true)
public List changePreference(String preferenceTypeKeyName, String value);
/**
* This service checks the result of a previously requested external authentication. [[SoftLayer_Container_User_Customer_External_Binding_Phone|Phone external binding]] container can be used for this service. Make sure to set the [[SoftLayer_Container_User_Customer_External_Binding_Phone::authenticationToken|authenticationToken]] that is generated by [[SoftLayer_User_Customer|initiateExternalAuthentication]] service.
*
* @see SoftLayer_User_Customer::checkExternalAuthenticationStatus
*/
@ApiMethod
public com.softlayer.api.service.container.user.customer.portal.Token checkExternalAuthenticationStatus(com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer);
/**
* Add a description here
*
*
*
* @see SoftLayer_User_Customer::checkPhoneFactorAuthenticationForPasswordSet
*/
@ApiMethod(instanceRequired = true)
public Boolean checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer);
/**
* Create a new subscriber for a given resource.
*
* @see SoftLayer_User_Customer::createNotificationSubscriber
*/
@ApiMethod(instanceRequired = true)
public Boolean createNotificationSubscriber(String keyName, Long resourceTableId);
/**
* Create a new user in the SoftLayer customer portal. createObject() creates a user's portal record and adds them into the SoftLayer community forums. It is not possible to set up SLL or PPTP enable flags during object creation. These flags are ignored during object creation. You will need to make a subsequent call to edit object in order to enable VPN access. An account's master user and sub-users who have the User Manage permission can add new users. createObject() creates users with a default permission set. After adding a user it may be helpful to set their permissions and hardware access.
*
* Note, neither password nor vpnPassword parameters are required.
*
* Password When a new user is created, an email will be sent to the new user's email address with a link to a url that will allow the new user to create or change their password for the SoftLayer customer portal.
*
* If the password parameter is provided and is not null, then that value will be validated. If it is a valid password, then the user will be created with this password. This user will still receive a portal password email. It can be used within 24 hours to change their password, or it can be allowed to expire, and the password provided during user creation will remain as the user's password.
*
* If the password parameter is not provided or the value is null, the user must set their portal password using the link sent in email within 24 hours. If the user fails to set their password within 24 hours, then a non-master user can use the "Reset Password" link on the login page of the portal to request a new email. A master user can use the link to retrieve a phone number to call to assist in resetting their password.
*
* The password parameter is ignored for VPN_ONLY users or for IBMid authenticated users.
*
* vpnPassword If the vpnPassword is provided, then the user's vpnPassword will be set to the provided password. When creating a vpn only user, the vpnPassword MUST be supplied. If the vpnPassword is not provided, then the user will need to use the portal to edit their profile and set the vpnPassword.
*
* IBMid considerations When a SoftLayer account is linked to a Platform Services (PaaS, formerly Bluemix) account, AND the trait on the SoftLayer Account indicating IBMid authentication is set, then SoftLayer will delegate the creation of the user to PaaS. The Platform Services "invite user" API call is asynchronous, and so no user object can be returned from this API call. In this specific case, this API will throw a SoftLayer_Exception_User_Customer_DelegateIamIdInvitationToPaas exception, with text indicating that the call was at least accepted by Platform Services. The Platform Services API is the preferred API for creating users based on IBMid in a linked account pair. If you have automation using this API that depends on getting a synchronous response with a user object with an id, you should contact SoftLayer Support to have the "IBMid authentication" trait set to 0 on this account. In that case, a normal SoftLayer user will be created (no IBMid association set up) and the createObject call will return synchronously as before.
*
* @see SoftLayer_User_Customer::createObject
*/
@ApiMethod
public Customer createObject(Customer templateObject, String password, String vpnPassword);
/**
* Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
*
* @see SoftLayer_User_Customer::createSubscriberDeliveryMethods
*/
@ApiMethod(instanceRequired = true)
public Boolean createSubscriberDeliveryMethods(String notificationKeyName, List deliveryMethodKeyNames);
/**
* Create a new subscriber for a given resource.
*
* @see SoftLayer_User_Customer::deactivateNotificationSubscriber
*/
@ApiMethod(instanceRequired = true)
public Boolean deactivateNotificationSubscriber(String keyName, Long resourceTableId);
/**
* Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.
*
* @see SoftLayer_User_Customer::editObject
*/
@ApiMethod(instanceRequired = true)
public Boolean editObject(Customer templateObject);
/**
* Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.
*
* @see SoftLayer_User_Customer::editObjects
*/
@ApiMethod
public Boolean editObjects(List templateObjects);
/**
* @see SoftLayer_User_Customer::findUserPreference
*/
@ApiMethod(instanceRequired = true)
public List findUserPreference(String profileName, String containerKeyname, String preferenceKeyname);
/**
* The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding.
*
* @see SoftLayer_User_Customer::getActiveExternalAuthenticationVendors
*/
@ApiMethod
public List getActiveExternalAuthenticationVendors();
/**
* @see SoftLayer_User_Customer::getAllowedDedicatedHostIds
*/
@ApiMethod(instanceRequired = true)
public List getAllowedDedicatedHostIds();
/**
* @see SoftLayer_User_Customer::getAllowedHardwareIds
*/
@ApiMethod(instanceRequired = true)
public List getAllowedHardwareIds();
/**
* @see SoftLayer_User_Customer::getAllowedVirtualGuestIds
*/
@ApiMethod(instanceRequired = true)
public List getAllowedVirtualGuestIds();
/**
* @see SoftLayer_User_Customer::getAuthenticationToken
*/
@ApiMethod(instanceRequired = true)
public Token getAuthenticationToken(Token token);
/**
* This API gets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity. If there is no default present, the API returns null, except in the special case where we find one active user linked to the IBMid. In that case, we will set the link from the IBMid to that user as default, and return the account of which that user is a member. Invoke this only on IBMid-authenticated users.
*
* @see SoftLayer_User_Customer::getDefaultAccount
*/
@ApiMethod(instanceRequired = true)
public Account getDefaultAccount(String providerType);
/**
* Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the "administrative" then "user admin" links.
*
* @see SoftLayer_User_Customer::getHardwareCount
*/
@ApiMethod(instanceRequired = true)
public Long getHardwareCount();
/**
* @see SoftLayer_User_Customer::getImpersonationToken
*/
@ApiMethod(instanceRequired = true)
public String getImpersonationToken();
/**
* Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.
*
* @see SoftLayer_User_Customer::getLoginToken
*/
@ApiMethod
public Common getLoginToken(Contract request);
/**
* An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all the accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IBMid-authenticated users.
*
* @see SoftLayer_User_Customer::getMappedAccounts
*/
@ApiMethod(instanceRequired = true)
public List getMappedAccounts(String providerType);
/**
* getObject retrieves the SoftLayer_User_Customer object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer service. You can only retrieve users that are assigned to the customer account belonging to the user making the API call.
*
* @see SoftLayer_User_Customer::getObject
*/
@ApiMethod(instanceRequired = true)
public Customer getObject();
/**
* This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown.
*
* @see SoftLayer_User_Customer::getOpenIdConnectMigrationState
*/
@ApiMethod(instanceRequired = true)
public MigrationState getOpenIdConnectMigrationState();
/**
* Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.
*
* @see SoftLayer_User_Customer::getPortalLoginToken
*/
@ApiMethod
public com.softlayer.api.service.container.user.customer.portal.Token getPortalLoginToken(String username, String password, Long securityQuestionId, String securityQuestionAnswer);
/**
* Select a type of preference you would like to get using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.
*
* @see SoftLayer_User_Customer::getPreference
*/
@ApiMethod(instanceRequired = true)
public Preference getPreference(String preferenceTypeKeyName);
/**
* Use any of the preference types to fetch or modify user preferences using [[SoftLayer_User_Customer::getPreference|getPreference]] or [[SoftLayer_User_Customer::changePreference|changePreference]], respectively.
*
* @see SoftLayer_User_Customer::getPreferenceTypes
*/
@ApiMethod(instanceRequired = true)
public List getPreferenceTypes();
/**
* Retrieve the authentication requirements for an outstanding password set/reset request. The password key provided to the user in an email generated by the [[SoftLayer_User_Customer::newUserPassword|newUserPassword]]. Password recovery keys are valid for 24 hours after they're generated.
*
* @see SoftLayer_User_Customer::getRequirementsForPasswordSet
*/
@ApiMethod(instanceRequired = true)
public PasswordSet getRequirementsForPasswordSet(PasswordSet passwordSet);
/**
* @see SoftLayer_User_Customer::getSupportPolicyDocument
*/
@ApiMethod(instanceRequired = true)
public byte[] getSupportPolicyDocument();
/**
* @see SoftLayer_User_Customer::getSupportPolicyName
*/
@ApiMethod(instanceRequired = true)
public String getSupportPolicyName();
/**
* @see SoftLayer_User_Customer::getSupportedLocales
*/
@ApiMethod(instanceRequired = true)
public List getSupportedLocales();
/**
* Retrieve a user object using a password token. When a new user is created or when a user has requested a password change using initiatePortalPasswordChange, they will have received an email that contains a url with a token. That token is used as the parameter for getUserIdForPasswordSet.
*
* @see SoftLayer_User_Customer::getUserIdForPasswordSet
*/
@ApiMethod
public Long getUserIdForPasswordSet(String key);
/**
* @see SoftLayer_User_Customer::getUserPreferences
*/
@ApiMethod(instanceRequired = true)
public List getUserPreferences(String profileName, String containerKeyname);
/**
* Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the "administrative" then "user admin" links.
*
* @see SoftLayer_User_Customer::getVirtualGuestCount
*/
@ApiMethod(instanceRequired = true)
public Long getVirtualGuestCount();
/**
* @see SoftLayer_User_Customer::inTerminalStatus
*/
@ApiMethod(instanceRequired = true)
public Boolean inTerminalStatus();
/**
* The service initiates an external authentication with the given external authentication vendor. The authentication container and its content will be verified before an attempt is made to initiate an external authentication. [[SoftLayer_Container_User_Customer_External_Binding_Phone|Phone external binding]] container can be used for this service.
*
* This service returns a unique authentication request token. You can use [[SoftLayer_User_Customer::checkExternalAuthenticationStatus|checkExternalAuthenticationStatus]] service to check if the authentication request is complete or not.
*
* @see SoftLayer_User_Customer::initiateExternalAuthentication
*/
@ApiMethod
public String initiateExternalAuthentication(com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer);
/**
* Sends password change email to the user containing url that allows the user the change their password. This is the first step when a user wishes to change their password. The url that is generated contains a one-time use token that is valid for only 24-hours.
*
* If this is a new master user who has never logged into the portal, then password reset will be initiated. Once a master user has logged into the portal, they must setup their security questions prior to logging out because master users are required to answer a security question during the password reset process. Should a master user not have security questions defined and not remember their password in order to define the security questions, then they will need to contact support at live chat or Revenue Services for assistance.
*
* Due to security reasons, the number reset requests per username are limited within a undisclosed timeframe.
*
* @see SoftLayer_User_Customer::initiatePortalPasswordChange
*/
@ApiMethod
public Boolean initiatePortalPasswordChange(String username);
/**
* A Brand Agent that has permissions to Add Customer Accounts will be able to request the password email be sent to the Master User of a Customer Account created by the same Brand as the agent making the request. Due to security reasons, the number of reset requests are limited within an undisclosed timeframe.
*
* @see SoftLayer_User_Customer::initiatePortalPasswordChangeByBrandAgent
*/
@ApiMethod(instanceRequired = true)
public Boolean initiatePortalPasswordChangeByBrandAgent(String username);
/**
* Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error.
*
* @see SoftLayer_User_Customer::inviteUserToLinkOpenIdConnect
*/
@ApiMethod(instanceRequired = true)
public Void inviteUserToLinkOpenIdConnect(String providerType);
/**
* Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal.
*
* @see SoftLayer_User_Customer::isMasterUser
*/
@ApiMethod(instanceRequired = true)
public Boolean isMasterUser();
/**
* This method is deprecated! SoftLayer Community Forums no longer exist, therefore, any password verified will return false. In the future, this method will be completely removed.
*
* Determine if a string is the given user's login password to the SoftLayer community forums.
*
* @see SoftLayer_User_Customer::isValidForumPassword
*/
@ApiMethod(instanceRequired = true)
public Void isValidForumPassword(String password);
/**
* Determine if a string is the given user's login password to the SoftLayer customer portal.
*
* @see SoftLayer_User_Customer::isValidPortalPassword
*/
@ApiMethod(instanceRequired = true)
public Boolean isValidPortalPassword(String password);
/**
* The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor.
*
* @see SoftLayer_User_Customer::performExternalAuthentication
*/
@ApiMethod
public com.softlayer.api.service.container.user.customer.portal.Token performExternalAuthentication(com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer);
/**
* Set the password for a user who has an outstanding password request. A user with an outstanding password request will have an unused and unexpired password key. The password key is part of the url provided to the user in the email sent to the user with information on how to set their password. The email was generated by the [[SoftLayer_User_Customer::initiatePortalPasswordRequest|initiatePortalPasswordRequest]] method. Password recovery keys are valid for 24 hours after they're generated.
*
* User portal passwords must match the following restrictions. Portal passwords must...
* * ...be over eight characters long.
* * ...be under twenty characters long.
* * ...contain at least one uppercase letter
* * ...contain at least one lowercase letter
* * ...contain at least one number
* * ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ + =
* * ...not match your username
* * ...not match your forum password
*
* @see SoftLayer_User_Customer::processPasswordSetRequest
*/
@ApiMethod(instanceRequired = true)
public Boolean processPasswordSetRequest(PasswordSet passwordSet, com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer);
/**
* Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.
*
* Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
*
* @see SoftLayer_User_Customer::removeAllDedicatedHostAccessForThisUser
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAllDedicatedHostAccessForThisUser();
/**
* Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.
*
* Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
*
* @see SoftLayer_User_Customer::removeAllHardwareAccessForThisUser
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAllHardwareAccessForThisUser();
/**
* Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.
*
* Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
*
* @see SoftLayer_User_Customer::removeAllVirtualAccessForThisUser
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAllVirtualAccessForThisUser();
/**
* Remove a user's API authentication key, removing that user's access to query the SoftLayer API.
*
* @see SoftLayer_User_Customer::removeApiAuthenticationKey
*/
@ApiMethod
public Boolean removeApiAuthenticationKey(Long keyId);
/**
* Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices.
*
* Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
*
* If the user has full dedicatedHost access, then it will provide access to "ALL but passed in" dedicatedHost ids.
*
* @see SoftLayer_User_Customer::removeBulkDedicatedHostAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean removeBulkDedicatedHostAccess(List dedicatedHostIds);
/**
* Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true.
*
* Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
*
* If the user has full hardware access, then it will provide access to "ALL but passed in" hardware ids.
*
* @see SoftLayer_User_Customer::removeBulkHardwareAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean removeBulkHardwareAccess(List hardwareIds);
/**
* Remove (revoke) multiple permissions from a portal user's permission set. [[Permissions]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user.
*
* Users can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account.
*
* If the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission.
*
* If the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user.
*
* Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
*
* @see SoftLayer_User_Customer::removeBulkPortalPermission
*/
@ApiMethod(instanceRequired = true)
public Boolean removeBulkPortalPermission(List permissions, Boolean cascadePermissionsFlag);
/**
* @see SoftLayer_User_Customer::removeBulkRoles
*/
@ApiMethod(instanceRequired = true)
public Void removeBulkRoles(List roles);
/**
* Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true.
*
* Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account.
*
* @see SoftLayer_User_Customer::removeBulkVirtualGuestAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean removeBulkVirtualGuestAccess(List virtualGuestIds);
/**
* Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices.
*
* Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
*
* @see SoftLayer_User_Customer::removeDedicatedHostAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean removeDedicatedHostAccess(Long dedicatedHostId);
/**
* @see SoftLayer_User_Customer::removeExternalBinding
*/
@ApiMethod(instanceRequired = true)
public Boolean removeExternalBinding(Binding externalBinding);
/**
* Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true.
*
* Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
*
* @see SoftLayer_User_Customer::removeHardwareAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean removeHardwareAccess(Long hardwareId);
/**
* Remove (revoke) a permission from a portal user's permission set. [[Permissions]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true.
*
* Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.
*
* If the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission.
*
* If the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user.
*
* Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter.
*
* @see SoftLayer_User_Customer::removePortalPermission
*/
@ApiMethod(instanceRequired = true)
public Boolean removePortalPermission(Permission permission, Boolean cascadePermissionsFlag);
/**
* @see SoftLayer_User_Customer::removeRole
*/
@ApiMethod(instanceRequired = true)
public Void removeRole(Role role);
/**
* @see SoftLayer_User_Customer::removeSecurityAnswers
*/
@ApiMethod(instanceRequired = true)
public Boolean removeSecurityAnswers();
/**
* Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true.
*
* Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account.
*
* @see SoftLayer_User_Customer::removeVirtualGuestAccess
*/
@ApiMethod(instanceRequired = true)
public Boolean removeVirtualGuestAccess(Long virtualGuestId);
/**
* @see SoftLayer_User_Customer::samlAuthenticate
*/
@ApiMethod
public com.softlayer.api.service.container.user.customer.portal.Token samlAuthenticate(String accountId, String samlResponse);
/**
* @see SoftLayer_User_Customer::samlBeginAuthentication
*/
@ApiMethod
public String samlBeginAuthentication(Long accountId);
/**
* @see SoftLayer_User_Customer::samlBeginLogout
*/
@ApiMethod(instanceRequired = true)
public String samlBeginLogout();
/**
* @see SoftLayer_User_Customer::samlLogout
*/
@ApiMethod(instanceRequired = true)
public Void samlLogout(String samlResponse);
/**
* An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users.
*
* @see SoftLayer_User_Customer::setDefaultAccount
*/
@ApiMethod(instanceRequired = true)
public Account setDefaultAccount(String providerType, Long accountId);
/**
* As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail.
*
* @see SoftLayer_User_Customer::silentlyMigrateUserOpenIdConnect
*/
@ApiMethod(instanceRequired = true)
public Boolean silentlyMigrateUserOpenIdConnect(String providerType);
/**
* This method is deprecated! SoftLayer Community Forums no longer exist, therefore, this method will return false. In the future, this method will be completely removed.
*
* Update a user's password on the SoftLayer community forums. As with portal passwords, user forum passwords must match the following restrictions. Forum passwords must...
* * ...be over eight characters long.
* * ...be under twenty characters long.
* * ...contain at least one uppercase letter
* * ...contain at least one lowercase letter
* * ...contain at least one number
* * ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ + =
* * ...not match your username
* * ...not match your portal password
* Finally, users can only update their own password.
*
* @see SoftLayer_User_Customer::updateForumPassword
*/
@ApiMethod(instanceRequired = true)
public Void updateForumPassword(String password);
/**
* Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription.
*
* @see SoftLayer_User_Customer::updateNotificationSubscriber
*/
@ApiMethod(instanceRequired = true)
public Boolean updateNotificationSubscriber(String notificationKeyName, Long active);
/**
* Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers.
*
* @see SoftLayer_User_Customer::updateSecurityAnswers
*/
@ApiMethod(instanceRequired = true)
public Boolean updateSecurityAnswers(List questions, List answers);
/**
* Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
*
* @see SoftLayer_User_Customer::updateSubscriberDeliveryMethod
*/
@ApiMethod(instanceRequired = true)
public Boolean updateSubscriberDeliveryMethod(String notificationKeyName, List deliveryMethodKeyNames, Long active);
/**
* Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN passwords must...
* * ...be over eight characters long.
* * ...be under twenty characters long.
* * ...contain at least one uppercase letter
* * ...contain at least one lowercase letter
* * ...contain at least one number
* * ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ =
* * ...not match your username
* * ...not match your forum password
* Finally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords.
*
* @see SoftLayer_User_Customer::updateVpnPassword
*/
@ApiMethod(instanceRequired = true)
public Boolean updateVpnPassword(String password);
/**
* Always call this function to enable changes when manually configuring VPN subnet access.
*
* @see SoftLayer_User_Customer::updateVpnUser
*/
@ApiMethod(instanceRequired = true)
public Boolean updateVpnUser();
/**
* @see SoftLayer_User_Customer::validateAuthenticationToken
*/
@ApiMethod
public com.softlayer.api.service.container.user.customer.portal.Token validateAuthenticationToken(Token authenticationToken);
/**
* The customer account that a user belongs to.
*
* @see SoftLayer_User_Customer::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* @see SoftLayer_User_Customer::getActions
*/
@ApiMethod(instanceRequired = true)
public List getActions();
/**
* A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
*
* @see SoftLayer_User_Customer::getAdditionalEmails
*/
@ApiMethod(instanceRequired = true)
public List getAdditionalEmails();
/**
* A portal user's API Authentication keys. There is a max limit of two API keys per user.
*
* @see SoftLayer_User_Customer::getApiAuthenticationKeys
*/
@ApiMethod(instanceRequired = true)
public List getApiAuthenticationKeys();
/**
* The CDN accounts associated with a portal user.
*
* @see SoftLayer_User_Customer::getCdnAccounts
*/
@ApiMethod(instanceRequired = true)
public List getCdnAccounts();
/**
* A portal user's child users. Some portal users may not have child users.
*
* @see SoftLayer_User_Customer::getChildUsers
*/
@ApiMethod(instanceRequired = true)
public List getChildUsers();
/**
* An user's associated closed tickets.
*
* @see SoftLayer_User_Customer::getClosedTickets
*/
@ApiMethod(instanceRequired = true)
public List getClosedTickets();
/**
* The dedicated hosts to which the user has been granted access.
*
* @see SoftLayer_User_Customer::getDedicatedHosts
*/
@ApiMethod(instanceRequired = true)
public List getDedicatedHosts();
/**
* The external authentication bindings that link an external identifier to a SoftLayer user.
*
* @see SoftLayer_User_Customer::getExternalBindings
*/
@ApiMethod(instanceRequired = true)
public List getExternalBindings();
/**
* A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.
*
* @see SoftLayer_User_Customer::getHardware
*/
@ApiMethod(instanceRequired = true)
public List getHardware();
/**
* Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'.
*
* @see SoftLayer_User_Customer::getHardwareNotifications
*/
@ApiMethod(instanceRequired = true)
public List getHardwareNotifications();
/**
* Whether or not a user has acknowledged the support policy.
*
* @see SoftLayer_User_Customer::getHasAcknowledgedSupportPolicyFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getHasAcknowledgedSupportPolicyFlag();
/**
* Permission granting the user access to all Dedicated Host devices on the account.
*
* @see SoftLayer_User_Customer::getHasFullDedicatedHostAccessFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getHasFullDedicatedHostAccessFlag();
/**
* Whether or not a portal user has access to all hardware on their account.
*
* @see SoftLayer_User_Customer::getHasFullHardwareAccessFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getHasFullHardwareAccessFlag();
/**
* Whether or not a portal user has access to all hardware on their account.
*
* @see SoftLayer_User_Customer::getHasFullVirtualGuestAccessFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getHasFullVirtualGuestAccessFlag();
/**
* @see SoftLayer_User_Customer::getIbmIdLink
*/
@ApiMethod(instanceRequired = true)
public Link getIbmIdLink();
/**
* @see SoftLayer_User_Customer::getLayoutProfiles
*/
@ApiMethod(instanceRequired = true)
public List getLayoutProfiles();
/**
* A user's locale. Locale holds user's language and region information.
*
* @see SoftLayer_User_Customer::getLocale
*/
@ApiMethod(instanceRequired = true)
public Locale getLocale();
/**
* A user's attempts to log into the SoftLayer customer portal.
*
* @see SoftLayer_User_Customer::getLoginAttempts
*/
@ApiMethod(instanceRequired = true)
public List getLoginAttempts();
/**
* A portal user's associated mobile device profiles.
*
* @see SoftLayer_User_Customer::getMobileDevices
*/
@ApiMethod(instanceRequired = true)
public List getMobileDevices();
/**
* Notification subscription records for the user.
*
* @see SoftLayer_User_Customer::getNotificationSubscribers
*/
@ApiMethod(instanceRequired = true)
public List getNotificationSubscribers();
/**
* An user's associated open tickets.
*
* @see SoftLayer_User_Customer::getOpenTickets
*/
@ApiMethod(instanceRequired = true)
public List getOpenTickets();
/**
* A portal user's vpn accessible subnets.
*
* @see SoftLayer_User_Customer::getOverrides
*/
@ApiMethod(instanceRequired = true)
public List getOverrides();
/**
* A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.
*
* @see SoftLayer_User_Customer::getParent
*/
@ApiMethod(instanceRequired = true)
public Customer getParent();
/**
* A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.
*
* @see SoftLayer_User_Customer::getPermissions
*/
@ApiMethod(instanceRequired = true)
public List getPermissions();
/**
* @see SoftLayer_User_Customer::getPreferences
*/
@ApiMethod(instanceRequired = true)
public List getPreferences();
/**
* @see SoftLayer_User_Customer::getRoles
*/
@ApiMethod(instanceRequired = true)
public List getRoles();
/**
* @see SoftLayer_User_Customer::getSalesforceUserLink
*/
@ApiMethod(instanceRequired = true)
public Link getSalesforceUserLink();
/**
* A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login.
*
* @see SoftLayer_User_Customer::getSecurityAnswers
*/
@ApiMethod(instanceRequired = true)
public List getSecurityAnswers();
/**
* A user's notification subscription records.
*
* @see SoftLayer_User_Customer::getSubscribers
*/
@ApiMethod(instanceRequired = true)
public List getSubscribers();
/**
* A user's successful attempts to log into the SoftLayer customer portal.
*
* @see SoftLayer_User_Customer::getSuccessfulLogins
*/
@ApiMethod(instanceRequired = true)
public List getSuccessfulLogins();
/**
* Whether or not a user is required to acknowledge the support policy for portal access.
*
* @see SoftLayer_User_Customer::getSupportPolicyAcknowledgementRequiredFlag
*/
@ApiMethod(instanceRequired = true)
public Long getSupportPolicyAcknowledgementRequiredFlag();
/**
* Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.
*
* @see SoftLayer_User_Customer::getSurveyRequiredFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getSurveyRequiredFlag();
/**
* The surveys that a user has taken in the SoftLayer customer portal.
*
* @see SoftLayer_User_Customer::getSurveys
*/
@ApiMethod(instanceRequired = true)
public List getSurveys();
/**
* An user's associated tickets.
*
* @see SoftLayer_User_Customer::getTickets
*/
@ApiMethod(instanceRequired = true)
public List getTickets();
/**
* A portal user's time zone.
*
* @see SoftLayer_User_Customer::getTimezone
*/
@ApiMethod(instanceRequired = true)
public Timezone getTimezone();
/**
* A user's unsuccessful attempts to log into the SoftLayer customer portal.
*
* @see SoftLayer_User_Customer::getUnsuccessfulLogins
*/
@ApiMethod(instanceRequired = true)
public List getUnsuccessfulLogins();
/**
* @see SoftLayer_User_Customer::getUserLinks
*/
@ApiMethod(instanceRequired = true)
public List getUserLinks();
/**
* A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.
*
* @see SoftLayer_User_Customer::getUserStatus
*/
@ApiMethod(instanceRequired = true)
public Status getUserStatus();
/**
* A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.
*
* @see SoftLayer_User_Customer::getVirtualGuests
*/
@ApiMethod(instanceRequired = true)
public List getVirtualGuests();
}
public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Async version of {@link Service#acknowledgeSupportPolicy}
*/
public Future acknowledgeSupportPolicy();
public Future acknowledgeSupportPolicy(ResponseHandler callback);
/**
* Async version of {@link Service#addApiAuthenticationKey}
*/
public Future addApiAuthenticationKey();
public Future addApiAuthenticationKey(ResponseHandler callback);
/**
* Async version of {@link Service#addBulkDedicatedHostAccess}
*/
public Future addBulkDedicatedHostAccess(List dedicatedHostIds);
public Future addBulkDedicatedHostAccess(List dedicatedHostIds, ResponseHandler callback);
/**
* Async version of {@link Service#addBulkHardwareAccess}
*/
public Future addBulkHardwareAccess(List hardwareIds);
public Future addBulkHardwareAccess(List hardwareIds, ResponseHandler callback);
/**
* Async version of {@link Service#addBulkPortalPermission}
*/
public Future addBulkPortalPermission(List permissions);
public Future addBulkPortalPermission(List permissions, ResponseHandler callback);
/**
* Async version of {@link Service#addBulkRoles}
*/
public Future addBulkRoles(List roles);
public Future addBulkRoles(List roles, ResponseHandler callback);
/**
* Async version of {@link Service#addBulkVirtualGuestAccess}
*/
public Future addBulkVirtualGuestAccess(List virtualGuestIds);
public Future addBulkVirtualGuestAccess(List virtualGuestIds, ResponseHandler callback);
/**
* Async version of {@link Service#addDedicatedHostAccess}
*/
public Future addDedicatedHostAccess(Long dedicatedHostId);
public Future addDedicatedHostAccess(Long dedicatedHostId, ResponseHandler callback);
/**
* Async version of {@link Service#addExternalBinding}
*/
public Future addExternalBinding(Binding externalBinding);
public Future addExternalBinding(Binding externalBinding, ResponseHandler callback);
/**
* Async version of {@link Service#addHardwareAccess}
*/
public Future addHardwareAccess(Long hardwareId);
public Future addHardwareAccess(Long hardwareId, ResponseHandler callback);
/**
* Async version of {@link Service#addNotificationSubscriber}
*/
public Future addNotificationSubscriber(String notificationKeyName);
public Future addNotificationSubscriber(String notificationKeyName, ResponseHandler callback);
/**
* Async version of {@link Service#addPortalPermission}
*/
public Future addPortalPermission(Permission permission);
public Future addPortalPermission(Permission permission, ResponseHandler callback);
/**
* Async version of {@link Service#addRole}
*/
public Future addRole(Role role);
public Future addRole(Role role, ResponseHandler callback);
/**
* Async version of {@link Service#addVirtualGuestAccess}
*/
public Future addVirtualGuestAccess(Long virtualGuestId);
public Future addVirtualGuestAccess(Long virtualGuestId, ResponseHandler callback);
/**
* Async version of {@link Service#assignNewParentId}
*/
public Future assignNewParentId(Long parentId, Boolean cascadePermissionsFlag);
public Future assignNewParentId(Long parentId, Boolean cascadePermissionsFlag, ResponseHandler callback);
/**
* Async version of {@link Service#changePreference}
*/
public Future> changePreference(String preferenceTypeKeyName, String value);
public Future changePreference(String preferenceTypeKeyName, String value, ResponseHandler> callback);
/**
* Async version of {@link Service#checkExternalAuthenticationStatus}
*/
public Future checkExternalAuthenticationStatus(com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer);
public Future checkExternalAuthenticationStatus(com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer, ResponseHandler callback);
/**
* Async version of {@link Service#checkPhoneFactorAuthenticationForPasswordSet}
*/
public Future checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer);
public Future checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer, ResponseHandler callback);
/**
* Async version of {@link Service#createNotificationSubscriber}
*/
public Future createNotificationSubscriber(String keyName, Long resourceTableId);
public Future createNotificationSubscriber(String keyName, Long resourceTableId, ResponseHandler callback);
/**
* Async version of {@link Service#createObject}
*/
public Future createObject(Customer templateObject, String password, String vpnPassword);
public Future createObject(Customer templateObject, String password, String vpnPassword, ResponseHandler callback);
/**
* Async version of {@link Service#createSubscriberDeliveryMethods}
*/
public Future createSubscriberDeliveryMethods(String notificationKeyName, List deliveryMethodKeyNames);
public Future createSubscriberDeliveryMethods(String notificationKeyName, List deliveryMethodKeyNames, ResponseHandler callback);
/**
* Async version of {@link Service#deactivateNotificationSubscriber}
*/
public Future deactivateNotificationSubscriber(String keyName, Long resourceTableId);
public Future deactivateNotificationSubscriber(String keyName, Long resourceTableId, ResponseHandler callback);
/**
* Async version of {@link Service#editObject}
*/
public Future editObject(Customer templateObject);
public Future editObject(Customer templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#editObjects}
*/
public Future editObjects(List templateObjects);
public Future editObjects(List templateObjects, ResponseHandler callback);
/**
* Async version of {@link Service#findUserPreference}
*/
public Future> findUserPreference(String profileName, String containerKeyname, String preferenceKeyname);
public Future findUserPreference(String profileName, String containerKeyname, String preferenceKeyname, ResponseHandler> callback);
/**
* Async version of {@link Service#getActiveExternalAuthenticationVendors}
*/
public Future> getActiveExternalAuthenticationVendors();
public Future getActiveExternalAuthenticationVendors(ResponseHandler> callback);
/**
* Async version of {@link Service#getAllowedDedicatedHostIds}
*/
public Future> getAllowedDedicatedHostIds();
public Future getAllowedDedicatedHostIds(ResponseHandler> callback);
/**
* Async version of {@link Service#getAllowedHardwareIds}
*/
public Future> getAllowedHardwareIds();
public Future getAllowedHardwareIds(ResponseHandler> callback);
/**
* Async version of {@link Service#getAllowedVirtualGuestIds}
*/
public Future> getAllowedVirtualGuestIds();
public Future getAllowedVirtualGuestIds(ResponseHandler> callback);
/**
* Async version of {@link Service#getAuthenticationToken}
*/
public Future getAuthenticationToken(Token token);
public Future getAuthenticationToken(Token token, ResponseHandler callback);
/**
* Async version of {@link Service#getDefaultAccount}
*/
public Future getDefaultAccount(String providerType);
public Future getDefaultAccount(String providerType, ResponseHandler callback);
/**
* Async version of {@link Service#getHardwareCount}
*/
public Future getHardwareCount();
public Future getHardwareCount(ResponseHandler callback);
/**
* Async version of {@link Service#getImpersonationToken}
*/
public Future getImpersonationToken();
public Future getImpersonationToken(ResponseHandler callback);
/**
* Async version of {@link Service#getLoginToken}
*/
public Future getLoginToken(Contract request);
public Future getLoginToken(Contract request, ResponseHandler callback);
/**
* Async version of {@link Service#getMappedAccounts}
*/
public Future> getMappedAccounts(String providerType);
public Future getMappedAccounts(String providerType, ResponseHandler> callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#getOpenIdConnectMigrationState}
*/
public Future getOpenIdConnectMigrationState();
public Future getOpenIdConnectMigrationState(ResponseHandler callback);
/**
* Async version of {@link Service#getPortalLoginToken}
*/
public Future getPortalLoginToken(String username, String password, Long securityQuestionId, String securityQuestionAnswer);
public Future getPortalLoginToken(String username, String password, Long securityQuestionId, String securityQuestionAnswer, ResponseHandler callback);
/**
* Async version of {@link Service#getPreference}
*/
public Future getPreference(String preferenceTypeKeyName);
public Future getPreference(String preferenceTypeKeyName, ResponseHandler callback);
/**
* Async version of {@link Service#getPreferenceTypes}
*/
public Future> getPreferenceTypes();
public Future getPreferenceTypes(ResponseHandler> callback);
/**
* Async version of {@link Service#getRequirementsForPasswordSet}
*/
public Future getRequirementsForPasswordSet(PasswordSet passwordSet);
public Future getRequirementsForPasswordSet(PasswordSet passwordSet, ResponseHandler callback);
/**
* Async version of {@link Service#getSupportPolicyDocument}
*/
public Future getSupportPolicyDocument();
public Future getSupportPolicyDocument(ResponseHandler callback);
/**
* Async version of {@link Service#getSupportPolicyName}
*/
public Future getSupportPolicyName();
public Future getSupportPolicyName(ResponseHandler callback);
/**
* Async version of {@link Service#getSupportedLocales}
*/
public Future> getSupportedLocales();
public Future getSupportedLocales(ResponseHandler> callback);
/**
* Async version of {@link Service#getUserIdForPasswordSet}
*/
public Future getUserIdForPasswordSet(String key);
public Future getUserIdForPasswordSet(String key, ResponseHandler callback);
/**
* Async version of {@link Service#getUserPreferences}
*/
public Future> getUserPreferences(String profileName, String containerKeyname);
public Future getUserPreferences(String profileName, String containerKeyname, ResponseHandler> callback);
/**
* Async version of {@link Service#getVirtualGuestCount}
*/
public Future getVirtualGuestCount();
public Future getVirtualGuestCount(ResponseHandler callback);
/**
* Async version of {@link Service#inTerminalStatus}
*/
public Future inTerminalStatus();
public Future inTerminalStatus(ResponseHandler callback);
/**
* Async version of {@link Service#initiateExternalAuthentication}
*/
public Future initiateExternalAuthentication(com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer);
public Future initiateExternalAuthentication(com.softlayer.api.service.container.user.customer.external.Binding authenticationContainer, ResponseHandler callback);
/**
* Async version of {@link Service#initiatePortalPasswordChange}
*/
public Future initiatePortalPasswordChange(String username);
public Future initiatePortalPasswordChange(String username, ResponseHandler callback);
/**
* Async version of {@link Service#initiatePortalPasswordChangeByBrandAgent}
*/
public Future initiatePortalPasswordChangeByBrandAgent(String username);
public Future initiatePortalPasswordChangeByBrandAgent(String username, ResponseHandler callback);
/**
* Async version of {@link Service#inviteUserToLinkOpenIdConnect}
*/
public Future inviteUserToLinkOpenIdConnect(String providerType);
public Future inviteUserToLinkOpenIdConnect(String providerType, ResponseHandler callback);
/**
* Async version of {@link Service#isMasterUser}
*/
public Future isMasterUser();
public Future isMasterUser(ResponseHandler callback);
/**
* Async version of {@link Service#isValidForumPassword}
*/
public Future isValidForumPassword(String password);
public Future isValidForumPassword(String password, ResponseHandler