SoftLayer User Customer::removePortalPermission
From SoftLayer Development Network Wiki
removePortalPermission is a member of the SoftLayer_User_Customer service.
Contents |
Overview
Remove a permission from a portal user's permission set. Permissions control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true.
Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.
Use the SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter.
Return Type
removePortalPermission returns the boolean data type.
Headers
Required Headers
removePortalPermission requires the following headers:
Parameters
removePortalPermission takes the following parameters:
permission
The permission you wish to add to the given user.
Error Handling
removePortalPermission throws the following exceptions:
- SoftLayer_Exception_Public
- Throw the exception "You may not remove permissions from your account." when trying to remove permissions from the user making calling the SoftLayer API.
- SoftLayer_Exception_Public
- Throw the exception "Please specify a permission key name." if the keyName property of the permission parameter is empty.
- SoftLayer_Exception_Public
- Throw the exception "Unable to locate a permission with the key name {key name}." when trying to remove an unknown permission from a user.
- SoftLayer_Exception_Public
- Throw the exception "Unable to remove user permission {key name}." if the API was unable to remove the given permission from the given portal user.
Associated Methods
- SoftLayer_User_Customer::addPortalPermission
- SoftLayer_User_Customer::addBulkPortalPermission
- SoftLayer_User_Customer::removeBulkPortalPermission
