SoftLayer User Customer::addApiAuthenticationKey

From SoftLayer Development Network Wiki

addApiAuthenticationKey is a member of the SoftLayer_User_Customer service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 4 Error Handling 5 Associated Methods 6 See Also

Overview

Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the users new API key. Each portal user is allowed a maximum of two API keys.

Return Type

addApiAuthenticationKey returns the string data type.

Headers

Required Headers

addApiAuthenticationKey requires the following headers:

• authenticate
• SoftLayer_User_CustomerInitParameters

Error Handling

addApiAuthenticationKey throws the following exceptions:

• SoftLayer_Exception_Public

Throw the exception "Each user can only have a maximum of two API keys." if the given user already has two API keys defined.

Associated Methods

• SoftLayer_User_Customer::removeApiAuthenticationKey

See Also

• Authenticating to the SoftLayer API