SoftLayer_User_Customer_OpenIdConnect::removeAllHardwareAccessForThisUser

Remove all hardware from a portal user’s hardware access list.

Description

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.

Parameters

None

Required Headers

• Authenticate
• SoftLayer_User_Customer_OpenIdConnectInitParameters

Optional Headers

• None

Return Values

• boolean

Error Handling

• Throws the exception “Unable to remove user hardware access.” if the API was unable to remove hardware access from the given portal user.
• Throws the exception “Inadequate permissions.” if the active user permissions do allow for access to the userId in question.

Associated Methods

• SoftLayer_User_Customer::addHardwareAccess
• SoftLayer_User_Customer::addBulkHardwareAccess
• SoftLayer_User_Customer::removeHardwareAccess

REST Example

curl -g -u $SL_USER:$SL_APIKEY -X GET \
'https://api.softlayer.com/rest/v3.1/SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeAllHardwareAccessForThisUser'