POST user

Update properties of the User. Current use is for updating a user's password, which requires Username, Password and NewPassword to be set by the client. This function can be performed in the MyPbhs portal as well. This method is offered for the convenience of the developer who wishes to integrate password changes into their system for when a User's password has expired. If you receive an error response, check the body for a Message which you can use to determine what the problem was. Password_Invalid_Format: The new password does not meet the criteria of a strong password (Must include lower case letters, upper case letters, numbers, non-alphanumeric characters). PasswordLengthTooShort: The new password is too short (8 characters is the current minimum). ChangePasswordNotContainNameOrEmail: The new password contains substrings of the User’s first name, last name or email. ChangePasswordMustRecyclePassword: The new password has already been used by this User previously.

Request Information

Parameters

NameDescriptionAdditional information
updateUser
See The Request body formats below for properties.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "NewPassword": "sample string 3"
}

text/html

Sample:
{"Username":"sample string 1","Password":"sample string 2","NewPassword":"sample string 3"}

application/xml, text/xml

Sample:
<UserDtoForUpdate>
  <Username>sample string 1</Username>
  <Password>sample string 2</Password>
  <NewPassword>sample string 3</NewPassword>
</UserDtoForUpdate>