SoftLayer User Customer::lostPassword
From SoftLayer Development Network Wiki
lostPassword is a member of the SoftLayer_User_Customer service.
Contents |
Overview
SoftLayer provides a way for users of it's customer portal to recover lost passwords. The lostPassword() method is the first step in this process. Given a valid username and email address, the SoftLayer API will email the address provided with a URL to visit to begin the password recovery process. The last part of this URL is a hash key that's used as an identifier throughout this process. Use this hash key in the setPasswordFromLostPasswordRequest method to reset a user's password. Password recovery hash keys are valid for 24 hours after they're generated.
Return Type
lostPassword returns the boolean data type.
Headers
Parameters
lostPassword takes the following parameters:
username
The username of the user whose password you wish to recover.
- Type: string
The email address of the user whose password you wish to recover. Provide the email address SoftLayer has on record for this user.
- Type: string
Error Handling
lostPassword throws the following exceptions:
- SoftLayer_Exception_Public
- Throw the exception "Please provide a username and email address." if no username or email address is provided.
- SoftLayer_Exception_Public
- Throw the exception "Unable to locate login information. Please note your username is case sensitive." if an account doesn't exist with the given username and email address.
