SoftLayer_User_Customer::getRequirementsForPasswordSet

Retrieve the authentication requirements for a user when attempting

Description

Retrieve the authentication requirements for an outstanding password set/reset request. The requirements returned in the same SoftLayer_Container_User_Customer_PasswordSet container which is provided as a parameter into this request. The SoftLayer_Container_User_Customer_PasswordSet::authenticationMethods array will contain an entry for each authentication method required for the user. See SoftLayer_Container_User_Customer_PasswordSet for more details.

If the user has required authentication methods, then authentication information will be supplied to the SoftLayer_User_Customer::processPasswordSetRequest method within this same SoftLayer_Container_User_Customer_PasswordSet container. All existing information in the container must continue to exist in the container to complete the password set/reset process.

Parameters

Required Headers

• SoftLayer_User_CustomerInitParameters

Optional Headers

• None

Return Values

• SoftLayer_Container_User_Customer_PasswordSet

Error Handling

• Throws the exception “Your request cannot be processed” if changes to the account or user has invalidated the password reset request, such as a user’s status changes and is no longer Active.
• Throws the exception “Invalid password recovery key” if no password recovery key was provided, the provided key was invalid, the key has expired, or the recovery key does not belong to this user.

Associated Methods

• SoftLayer_User_Customer::initiatePortalPasswordChange
• SoftLayer_User_Customer::getUserIdForPasswordSet
• SoftLayer_User_Customer::processPasswordSetRequest

REST Example

curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_User_Customer_PasswordSet]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getRequirementsForPasswordSet'