|
|
APIWebServer.User.PasswordUpdate
| Field | Variable | ...as | Description |
|---|---|---|---|
| UserSurrogate | Data | Input | The unique identification of the user. |
| UserPassword | Data | Input | The new password for the user. |
| ErrorMessage | Error | Output | A text describing the error. |
This API can be used when a password is to be changed for a user. The API performs the same validation as the PasswordUpdateValidation.
If the validation is successful the password will be updated for the user specified by the user surrogate and the *Returned status field is set to *Successful.
If the validation fails *Returned status will be different from *Successful and the ErrorMessage field will contain a text describing the reason for the failure.
If you do not have the user surrogate for the user whose password you want to update you can call the UserSingleFetchSiteLogin with information about the site and the login name for the user to obtain the surrogate.
Online documentation - WebsydianExpress v3.0