User
SoftLayer_User_Customer

Overview

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.

Methods


addApiAuthenticationKey	Create a user's API authentication key.
addBulkHardwareAccess	Add multiple hardware to a portal user's hardware access list.
addBulkPortalPermission	Add multiple permissions to a portal user's permission set.
addBulkRoles
addBulkVirtualGuestAccess	Add multiple CloudLayer Computing Instances to a portal user's access list.
addHardwareAccess	Add hardware to a portal user's hardware access list.
addPortalPermission	Add a permission to a portal user's permission set.
addRole
addVirtualGuestAccess	Add a CloudLayer Computing Instance to a portal user's access list.
changeUsername
createNotificationSubscriber	Create a new subscriber for a given resource.
createObject	Create a new user record.
deactivateNotificationSubscriber	Delete a subscriber for a given resource.
editObject	Update a user's information.
editObjects	Update a collection of users' information
getAccount	Retrieve the customer account that a user belongs to.
getActions	Retrieve Array
getActiveExternalAuthenticationVendors	Get a list of active external authentication vendors for a SoftLayer user.
getAdditionalEmails	Retrieve a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
getApiAuthenticationKeys	Retrieve a portal user's API Authentication keys. There is a max limit of two API keys per user.
getAuthenticationToken
getCdnAccounts	Retrieve the CDN accounts associated with a portal user.
getChildUsers	Retrieve a portal user's child users. Some portal users may not have child users.
getDefaultSecurityQuestions	Retrieve default security questions.
getExternalBindings	Retrieve the external authentication bindings that link an external identifier to a SoftLayer user.
getHardware	Retrieve a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.
getHardwareCount	Retrieve the current number of servers a portal user has access to.
getHardwareNotifications	Retrieve 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'.
getHasFullHardwareAccessFlag	Retrieve whether or not a portal user has access to all hardware on their account.
getHasFullVirtualGuestAccessFlag	Retrieve whether or not a portal user has access to all hardware on their account.
getLayoutProfiles	Retrieve Array
getLoginAttempts	Retrieve a user's attempts to log into the SoftLayer customer portal.
getMobileDevices	Retrieve a portal user's associated mobile device profiles.
getObject	Retrieve a SoftLayer_User_Customer record.
getOverrides	Retrieve a portal user's vpn accessible subnets.
getParent	Retrieve a portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.
getPermissions	Retrieve a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.
getPortalLoginToken	Authenticate a user for the SoftLayer customer portal
getRoles	Retrieve Array
getSalesforceUserLink	Retrieve Array
getSecurityAnswers	Retrieve 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.
getSubscribers	Retrieve a user's notification subscription records.
getSuccessfulLogins	Retrieve a user's successful attempts to log into the SoftLayer customer portal.
getSurveyRequiredFlag	Retrieve whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.
getSurveys	Retrieve the surveys that a user has taken in the SoftLayer customer portal.
getTickets	Retrieve an user's associated tickets.
getTimezone	Retrieve a portal user's time zone.
getUnsuccessfulLogins	Retrieve a user's unsuccessful attempts to log into the SoftLayer customer portal.
getUserFromLostPasswordRequest	Retrieve a user object using a lost password request key
getUserLinks	Retrieve Array
getUserStatus	Retrieve a portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.
getVirtualGuestCount	Retrieve the current number of CloudLayer Computing Instances a portal user has access to.
getVirtualGuests	Retrieve 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.
isMasterUser	Determine if a portal user is a master user.
isValidForumPassword	Determine if a string is a user's forum password.
isValidPortalPassword	Determine if a string is a user's portal password.
lostPassword	Generate a lost password request
performExternalAuthentication	Perform an external authentication using the given authentication container.
removeAllHardwareAccessForThisUser	Remove all hardware from a portal user's hardware access list.
removeAllVirtualAccessForThisUser	Remove all cloud computing instances from a portal user's instance access list.
removeApiAuthenticationKey	Remove a user's API authentication key.
removeBulkHardwareAccess	Remove multiple hardware from a portal user's hardware access list.
removeBulkPortalPermission	Remove multiple permissions from a portal user's permission set.
removeBulkRoles
removeBulkVirtualGuestAccess	Remove multiple CloudLayer Computing Instances from a portal user's access list.
removeHardwareAccess	Remove hardware from a portal user's hardware access list.
removePortalPermission	Remove a permission from a portal user's permission set.
removeRole
removeVirtualGuestAccess	Remove a CloudLayer Computing Instance from a portal user's access list.
setPasswordFromLostPasswordRequest	Set a user's password using a password recovery key
updateForumPassword	Update a user's forum password
updatePassword	Update a user's portal password
updateSecurityAnswers	Update portal login security questions and answers.
updateVpnPassword	Update a user's VPN password
updateVpnUser	Creates or updates a user's VPN access privileges.
validateAuthenticationToken
findUserPreference
getUserPreferences
resetExpiredPassword	Reset a users expired password.
checkExternalAuthenticationStatus	Checks if an external authentication is complete or not
initiateExternalAuthentication	Initiates an external authentication using the given authentication container.
getAnonymousOrderUserFlag	Retrieve Array
getHideSLDN	Retrieve Array
getImpersonationToken
addNotificationSubscriber
updateNotificationSubscriber
createSubscriberDeliveryMethods
updateSubscriberDeliveryMethod

Primary links

UserSoftLayer_User_Customer

Overview

Methods

User
SoftLayer_User_Customer