GetUserPasswordResetToken Method

Member of finUserFunctions
Get a Token to reset a User's Web Password.

<para> An Audit Log with a key of 'PasswordResetToken' will be written against the User detailing that a Password Reset Token has been generated. The audit notes will record the Email Address. </para> <para> Can be used by User portals such as finPOWER Connect Cloud. </para>

Syntax

finUserFunctions.GetUserPasswordResetToken(userPk, expiryMinutes, emailAddress, resetToken, emailAddressInvalid)

Parameters

NameTypeOptionalByRefDescription
userPk Integer The primary key of the User.
expiryMinutes Integer The number of minutes after which the returned token will expire between 1 and 60.
emailAddress String An Email Address which, if not blank, will be validated to ensure it matches an Email Address recorded against the User.
resetToken String ByRef The Reset Token.
emailAddressInvalid Boolean ByRef Indicates whether this method failed due to the supplied Email Address being invalid for the User.

Return Value

Boolean

A Boolean value indicating success.

Member of:
finUserFunctions
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0