|
|
APIWebServer.User.PasswordUpdateValidation
| 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 an existing user. The API only performs validation - not any updates. The *Returned status field is set to *Successful if the validation is successful.
If the validation fails 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.
As the PasswordUpdate function itself calls this validation function, you should only call this function if you want to make sure that the update will be successful before calling the update function (e.g. if you have a set of pages performing data capture - where the update itself must not be done before the last panel has been accepted).
Online documentation - WebsydianExpress v3.5