processPasswordSetRequest


SoftLayer_User_Customer_OpenIdConnect::processPasswordSetRequest

Set the password for a user who has a valid password request key

Overview

Set the password for a user who has an outstanding password request. A user with an outstanding password request will have an unused and unexpired password key. The password key is part of the url provided to the user in the email sent to the user with information on how to set their password. The email was generated by the SoftLayer_User_Customer::initiatePortalPasswordRequest request. Password recovery keys are valid for 24 hours after they’re generated.

If the user has required authentication methods as specified by in the SoftLayer_Container_User_Customer_PasswordSet container returned from the SoftLayer_User_Customer::getRequirementsForPasswordSet request, then additional requests must be made to processPasswordSetRequest to authenticate the user before changing the password. First, if the user has security questions set on their profile, they will be required to answer one of their questions correctly. Next, if the user has Verisign, Google Authentication, or Phone Factor on their account, they must authenticate according to the two-factor provider. All of this authentication is done using the SoftLayer_Container_User_Customer_PasswordSet container. If the user has Phone Factor authentication, additional requests to SoftLayer_User_Customer::checkPhoneFactorAuthenticationForPasswordSet is required until a response other than Awaiting Response is received.

User portal passwords must match the following restrictions. Portal 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


Parameters

Name Type Description
passwordSet SoftLayer_Container_User_Customer_PasswordSet A container with the information required for setting customer password
authenticationContainer SoftLayer_Container_User_Customer_External_Binding The authentication container with the external authentication information.

Required Headers

  • SoftLayer_User_Customer_OpenIdConnectInitParameters

Return Values

  • boolean

Associated Methods

Error Handling

  • SoftLayer_Exception_Public

<<< EOT

  • SoftLayer_Exception_Public

<<< EOT

  • SoftLayer_Exception_InvalidValue

<<< EOT

  • SoftLayer_Exception_User_Customer_InvalidSecurityQuestionAnswer

<<< EOT

  • SoftLayer_Exception_User_Customer_AccountLocked

<<< EOT

  • SoftLayer_Exception_User_Customer_External_Binding_SecurityCodeRequired

<<< EOT

  • SoftLayer_Exception_User_Customer_External_Binding_TotpAuthenticationRequired

<<< EOT

  • SoftLayer_Exception_User_Customer_External_Binding_PhoneAuthenticationRequired

<<< EOT

  • SoftLayer_Exception_User_Customer_External_Binding_AwaitingResponse

<<< EOT