SoftLayer User Customer
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_User_Customer service. For information on the SoftLayer_User_Customer data type please see SoftLayer_User_Customer (type).
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.
Endpoints
| SOAP WSDL | http://api.service.softlayer.com/soap/v3/SoftLayer_User_Customer?wsdl |
| XML-RPC | http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_User_Customer |
Methods
addApiAuthenticationKey
Adds API Authentication key to user.
- returns
- bool
- parameters
- None
addBulkHardwareAccess
Adds a user's access to several hardware.
- returns
- bool
- parameters
- int[] hardwareIds
addBulkPortalPermission
Adds a user portal permissions.
- returns
- bool
- parameters
- SoftLayer_User_Customer_CustomerPermission_Permission[] permissions
addHardwareAccess
Adds a user's access to a hardware.
- returns
- bool
- parameters
- int hardwareId
addPortalPermission
Adds a user's portal permission.
- returns
- bool
- parameters
- SoftLayer_User_Customer_CustomerPermission_Permission permission
createObject
Creates a new user record.
- returns
- parameters
- SoftLayer_User_Customer templateObject
editObject
Updates a user's information then returns true if successful.
- returns
- bool
- parameters
- SoftLayer_User_Customer templateObject
editObjects
Updates a bulk of users information then returns true if successful.
- returns
- bool
- parameters
- SoftLayer_User_CustomerArray templateObjects
getAccount
Retrieve the customer account that a user belongs to.
- returns
- parameters
- None
getAdditionalEmails
Retrieve portal user's additional emails.
- returns
- parameters
- None
getApiAuthenticationKeys
Retrieve a portal user's API Authentication keys. There is a max limit of two API keys per user.
- returns
- parameters
- None
getChildUsers
Retrieve a portal user's child users. Some portal users may not have child users.
- returns
- parameters
- None
getHardwareCount
Retrieve the current number of servers a portal user has access to.
- returns
- int
- parameters
- None
getHardwareNotifications
Retrieve any 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'
- returns
- parameters
- None
getObject
Retrieve a SoftLayer_User_Customer record.
- returns
- parameters
- None
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.
- returns
- parameters
- None
getPermissions
Retrieve a portal user's permissions. These permissions control that user's access to the SoftLayer customer portal and API.
- returns
- parameters
- None
getSecurityAnswers
Retrieve a portal user's security answers. Some portal users may not have security answers.
- returns
- parameters
- None
getTimezone
Retrieve a portal user's time zone.
- returns
- parameters
- None
getUserFromLostPasswordRequest
Retrieve the user object using the lost password request key.
- returns
- parameters
- string key
getUserStatus
Retrieve a portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.
- returns
- parameters
- None
isMasterUser
Determine if a portal user is a master user.
- returns
- bool
- parameters
- None
lostPassword
Process the request to reset lost password.
- returns
- bool
- parameters
- string username
- string email
removeApiAuthenticationKey
Removes API Authentication key from user.
- returns
- bool
- parameters
- int keyId
removeBulkHardwareAccess
Removes a user's access to several hardware.
- returns
- bool
- parameters
- int[] hardwareIds
removeBulkPortalPermission
Removes a user's portal permissions.
- returns
- bool
- parameters
- SoftLayer_User_Customer_CustomerPermission_Permission[] permissions
removeHardwareAccess
Removes a user's access to a hardware.
- returns
- bool
- parameters
- int hardwareId
removePortalPermission
Removes a user's portal permission.
- returns
- bool
- parameters
- SoftLayer_User_Customer_CustomerPermission_Permission permission
updateForumPassword
Update forum password.
- returns
- bool
- parameters
- string password
updatePassword
Update portal password.
- returns
- bool
- parameters
- string password
updateSecurityAnswers
Update security answers.
- returns
- bool
- parameters
- SoftLayer_User_Security_Question[] questions
- string[] answers
