getRequirementsForPasswordSet


SoftLayer_User_Customer::getRequirementsForPasswordSet

Retrieve the authentication requirements for a user when attempting

Overview

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

Name Type Description
passwordSet SoftLayer_Container_User_Customer_PasswordSet Container used to exchange information

Required Headers

  • SoftLayer_User_CustomerInitParameters

Return Values

Associated Methods

Error Handling

  • SoftLayer_Exception_Public

<<< EOT

  • SoftLayer_Exception_Public

<<< EOT