initiatePortalPasswordChange


SoftLayer_User_Customer::initiatePortalPasswordChange

Request email to allow user to change their password

Description

Sends password change email to the user containing url that allows the user the change their password. This is the first step when a user wishes to change their password. The url that is generated contains a one-time use token that is valid for only 24-hours.

If this is a new master user who has never logged into the portal, then password reset will be initiated. Once a master user has logged into the portal, they must setup their security questions prior to logging out because master users are required to answer a security question during the password reset process. Should a master user not have security questions defined and not remember their password in order to define the security questions, then they will need to contact support at live chat or Revenue Services for assistance.

Due to security reasons, the number of reset requests per username are limited within a undisclosed timeframe.


Parameters

Name Type Description
username string The username of the user who is changing their password.

Required Headers

Optional Headers

  • None

Return Values

  • boolean

Error Handling

  • Throws the exception “Invalid value provided for Username” if no username is provided.

Associated Methods

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