addDedicatedHostAccess

Classes SoftLayer_User_Customer
Tags method sldn user

SoftLayer_User_Customer::addDedicatedHostAccess

Grant access to the user for a single dedicated host device.

Description

Grants the user access 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, 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.

Only the USER_MANAGE permission is required to execute this.

Parameters

Name Type Description
dedicatedHostId int The identifier of the dedicatedHost to add to a user’s dedicatedHost access list.

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 add dedicated host access to a master user.
  • Throws the exception “You may not grant or deny yourself device access.” when trying to add 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 add 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 “You may not add dedicated host permissions that the parent does not possess to this account.” when trying to add dedicated host access to the user and the parent user does not possess access.
  • Throws the exception “Please specify a valid dedicated host id.” if the given dedicated host id is not valid.
  • Throws the exception “Unable to add user dedicated host access.” if the API was unable to assign dedicated host access to 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/{SoftLayer_User_CustomerID}/addDedicatedHostAccess'