auth::password::recover_password (public)

 auth::password::recover_password [ -authority_id authority_id ] \
    [ -username username ] [ -email email ]

Defined in packages/acs-authentication/tcl/password-procs.tcl

Handles forgotten passwords. Attempts to retrieve a password; if not possible, attempts to reset a password. If it succeeds, it emails the user. For all outcomes, it returns a message to be displayed.

Switches:

-authority_id (optional)

The ID of the authority that the user is trying to log into.

-username (optional)

The username that the user's trying to log in with.

-email (optional)

Email can be supplied instead of authority_id and username.

Returns:

Array list with the following entries:

• password_status: ok, no_support, failed_to_connect
• password_message: Human-readable message to be relayed to the user. May contain HTML.

Testcases:

auth_password_recover