Starts the password reset process for a user via a VETtrak web portal.
[WebMethod(Description = "Triggers a password reset for a user via a VETtrak web portal")] public TAuthenticate TriggerPortalPasswordReset(string token, string clientCode);
Parameters |
Description |
string token |
String containing an authentication token. |
string clientCode |
String containing the client code of the client to initiate the password reset process for. |
TAuthenticate indicating the result.
This function allows you to trigger the password reset process for a user. This process will cause a VETtrak Web Portal to send a password reset email to the user with a button that takes the user to the web portal to set a new VETtrak password on their account. This can be useful in particular if you are creating new students who need to be able to access the VETtrak Student Portal immediately.
To use this function, all of the following must be in place:
A token is passed for authentication. If the authentication fails, or other errors occur, the error is returned in the TAuthenticate object.
This function has security level "Restricted". Users that have explicitly been granted permission to the API can use it with any parameters, otherwise, the logged-in client can only reset their own password.
Copyright (c) VETtrak 2022. All rights reserved.
|