SoftLayer User Customer::getUserFromLostPasswordRequest
From SoftLayer Development Network Wiki
getUserFromLostPasswordRequest is a member of the SoftLayer_User_Customer service.
Contents |
Overview
Retrieve a user object using a password recovery key received in an email generated by the lostPassword method. The SoftLayer customer portal uses getUserFromLostPasswordRequest() to retrieve user security questions. Password recovery keys are valid for 24 hours after they're generated.
Return Type
getUserFromLostPasswordRequest returns the SoftLayer_User_Customer data type.
Headers
Parameters
getUserFromLostPasswordRequest takes the following parameters:
key
A password recovery hash key retrieved from an email sent by the lostPassword method.
- Type: string
Error Handling
getUserFromLostPasswordRequest throws the following exceptions:
- SoftLayer_Exception_Public
- Throw the exception "Please provide a valid password recovery key." if no password recorver key was provided, the provided key was invalid, or the key has expired.
