SoftLayer User Customer::removeApiAuthenticationKey
From SoftLayer Development Network Wiki
removeApiAuthenticationKey is a member of the SoftLayer_User_Customer service.
Contents |
Overview
Remove a user's API authentication key, removing that user's access to query the SoftLayer API.
Return Type
removeApiAuthenticationKey returns the boolean data type.
Headers
Required Headers
removeApiAuthenticationKey requires the following headers:
Parameters
removeApiAuthenticationKey takes the following parameters:
keyId
The identifier of the API authentication key you wish to remove.
- Type: integer
Error Handling
removeApiAuthenticationKey throws the following exceptions:
- SoftLayer_Exception_Public
- Throw the exception "Please provide an API Authentication key ID." when not passing or passing an invalid API authentication key ID.
