SoftLayer User Customer::updateForumPassword

From SoftLayer Development Network Wiki

updateForumPassword 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 community forums. As with portal passwords, user forum passwords must match the following restrictions. Forum 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 portal password

Finally, users can only update their own password.

Return Type

updateForumPassword returns the boolean data type.

Headers

Required Headers

updateForumPassword requires the following headers:

Parameters

updateForumPassword takes the following parameters:

password

Your new forum password

Type: string

Error Handling

updateForumPassword throws the following exceptions:

SoftLayer_Exception_Public

Throw the exception 'Access is denied.' if a user tries to change another user's forum 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.

SoftLayer_Exception_Public

Throw the exception "This user does not have a corresponding forum user." if the current user does not have a corresponding user in the SoftLayer community forums. If you recieve this error then please contact SoftLayer support to add your forum user.