foundation-comms.messagebuilder.createforgotpasswordmessage

Home > @genesislcap/foundation-comms > MessageBuilder > createForgotPasswordMessage

MessageBuilder.createForgotPasswordMessage() method

Creates a forgot password message.

Signature:

createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;

Parameters

Parameter	Type	Description
username	string	The username.
returnUrl	string	The return URL.
requester	string	(Optional) The requester.

Returns:

Message<MessageDetails.ForgotPassword>

The forgot password message.

Remarks

EVENT_SELF_SERVICE_PASSWORD_RESET