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.

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_password_recover auth_password_recover (test acs-authentication) auth::password::recover_password auth::password::recover_password test_auth_password_recover->auth::password::recover_password _ _ (public) auth::password::recover_password->_ acs_user::get_user_info acs_user::get_user_info (public) auth::password::recover_password->acs_user::get_user_info ad_returnredirect ad_returnredirect (public) auth::password::recover_password->ad_returnredirect ad_script_abort ad_script_abort (public) auth::password::recover_password->ad_script_abort auth::UseEmailForLoginP auth::UseEmailForLoginP (public) auth::password::recover_password->auth::UseEmailForLoginP packages/acs-subsite/www/register/recover-password.tcl packages/acs-subsite/ www/register/recover-password.tcl packages/acs-subsite/www/register/recover-password.tcl->auth::password::recover_password

Testcases:
auth_password_recover
[ show source ]
Show another procedure: