removeAllDedicatedHostAccessForThisUser

Classes SoftLayer_User_Customer_OpenIdConnect_TrustedProfile
Tags method sldn user

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeAllDedicatedHostAccessForThisUser

Revoke access to all dedicated hosts on the account for this user.

Description

Revoke access to all dedicated hosts on the account for this user. 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. 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

Optional Headers

  • None

Return Values

  • boolean

Error Handling

  • 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.
  • Throws the exception “Inadequate permissions.” if the active user permissions do allow for access to the userId in question.

Associated Methods

curl -g -u $SL_USER:$SL_APIKEY -X GET \
'https://api.softlayer.com/rest/v3.1/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeAllDedicatedHostAccessForThisUser'