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