PasswordChange Object

Contains information about a change of user password or email address.

For information about password rules, see Password Rules on the Platform.

This object is used by the following operations:

The properties included in the PasswordChange object are listed below. All values are optional.

Property Type Description
OldPassword string The old password.
NewPassword string The new password.
NewEmail string The new email address, if the user is changing the email address on record. If there is no change, the current email is included. Required if sent in the request.
ForcePasswordChangeOnLogin boolean Indicates whether the user will be forced to change the password, on next login. Default: false. If not specified, password change is not enforced.