SoftLayer User Customer::addBulkHardwareAccess
From SoftLayer Development Network Wiki
addBulkHardwareAccess is a member of the SoftLayer_User_Customer service.
Contents |
Overview
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.
Return Type
addBulkHardwareAccess returns the boolean data type.
Headers
Required Headers
addBulkHardwareAccess requires the following headers:
Parameters
addBulkHardwareAccess takes the following parameters:
hardwareIds
Hardware IDs
- Type: array of integers
Error Handling
addBulkHardwareAccess throws the following exceptions:
- SoftLayer_Exception_Public
- Throw the exception "You may not add hardware access to your account." when trying to add hardware access to the user making calling the SoftLayer API.
- SoftLayer_Exception_Public
- Throw the exception "Please specify a valid hardware id." if the given hardware id is not a valid hardware id.
- SoftLayer_Exception_Public
- Throw the exception "Unable to add user hardware access." if the API was unable to assign hardware access to the given portal user.
Associated Methods
- SoftLayer_User_Customer::addHardwareAccess
- SoftLayer_User_Customer::removeHardwareAccess
- SoftLayer_User_Customer::removeBulkHardwareAccess
