SoftLayer User Customer::updatePassword

From SoftLayer Development Network Wiki

updatePassword is a member of the SoftLayer_User_Customer service.

1 Overview
2 Return Type
3 Headers
- 3.1 Required Headers
4 Parameters
- 4.1 password
5 Error Handling
6 Associated Methods
7 External Links

Overview

Update a user's password on the SoftLayer customer portal. As with forum passwords, user portal passwords must match the following restrictions. Portal passwords must...

...be over eight characters long.
...be under twenty characters long.
...contain at least one uppercase letter
...contain at least one lowercase letter
...contain at least one number
...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ + =
...not match your username
...not match your forum password

Finally, users can only update their own password.

Return Type

updatePassword returns the boolean data type.

Headers

Required Headers

updatePassword requires the following headers:

Parameters

updatePassword takes the following parameters:

password

Your new portal password

Type: string

Error Handling

updatePassword throws the following exceptions:

SoftLayer_Exception_Public

Throw the exception "Access is denied." if a user tries to change another user's portal password.

SoftLayer_Exception_Public

Throw the exception "Your portal password must" followed by a list of violated password rules if the given password fails to match any of the above restrictions.