removeDedicatedHostAccess

Classes SoftLayer_User_Customer_OpenIdConnect_TrustedProfile
Tags method sldn user

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeDedicatedHostAccess

Revoke access for the user to a single dedicated hosts device.

Description

Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user’s account has devices to which the user has not been granted access or the access has been revoked, then “not found” exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account’s master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

Parameters

Name Type Description
dedicatedHostId int DedicatedHost ID

Required Headers

Optional Headers

  • None

Return Values

  • boolean

Error Handling

  • Throws the exception “You may not grant or deny Master User device access.” when trying to remove dedicated host access to a master user.
  • Throws the exception “You may not grant or deny yourself device access.” when trying to remove dedicated host access to the user making the call to the SoftLayer API.
  • Throws the exception “You may not grant or deny device access to other users.” when trying to remove dedicated host access the user making the API call is not their account’s master user or does not have the “USER_MANAGE” portal permission.
  • Throws the exception “Please specify a valid dedicated host id.” if the given dedicated host id is not a valid dedicated host id.
  • Throws the exception “Unable to remove user dedicated host access.” if the API was unable to remove dedicated host access from the given portal user.

Associated Methods

curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeDedicatedHostAccess'