removeVirtualGuestAccess

Classes SoftLayer_User_Customer_OpenIdConnect
Tags method sldn user

SoftLayer_User_Customer_OpenIdConnect::removeVirtualGuestAccess

Remove a CloudLayer Computing Instance from a portal user’s access list.

Description

Remove a CloudLayer Computing Instance from a portal user’s access list. A user’s CloudLayer Computing Instance access list controls which of an account’s computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do 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 CloudLayer Computing Instance you’re attempting remove add then removeVirtualGuestAccess() returns true.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account’s master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account.

Parameters

Name Type Description
virtualGuestId int The internal identifier of the CloudLayer Computing Instance you wish to remove access to.

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 virtual guest access to a master user.
  • Throws the exception “You may not grant or deny yourself device access.” when trying to remove virtual guest 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 virtual guest 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 CloudLayer Computing Instance id.” if the given CloudLayer Computing Instance id is not a valid id.
  • Throws the exception “Unable to remove user CloudLayer Computing Instance access.” if the API was unable to remove CloudLayer Computing Instance 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/{SoftLayer_User_Customer_OpenIdConnectID}/removeVirtualGuestAccess'