A change to the authentication framework configuration may inadvertently cause you to be locked out of the user interface. The Emergency One-time Login URL tool enables access by allowing you to create a one-time, session-limited login for any user from the command line. You will have continued access to your system in the event of lost passwords and/or failed Authentication Providers.

Note: The Emergency One-time Login URL tool is applicable only when the new authentication framework is in use. This tool still executes and returns a ticket, but attempting to access the One Time Login page returns an error.

To recover from a Lockout or Bad Configuration when the Legacy Authentication Provider is Active, see Legacy Authentication Provider.

For security reasons, use of this tool is specifically logged in the Authentication Framework Logs. To learn more, see Authentication Logs.

Use the emergency one-time login URL tool

This Emergency One-time Login URL Tool allows you to create a secure temporary session for any user account. This tool was requested by administrators and enables the Log In As... function.

The script is called AuthenticationOneTimeLogin.sh|bat and is located in the blackboard/tools/admin/ folder. The AuthenticationOneTimeLogin.sh|bat script takes the following arguments:

  • -u username: The username of the user to log in as.
  • -t minutes: The number of minutes before the session token expires. The default is 15 minutes.
  • -e entry code: The entry code that must be typed in a browser to authorize access. The default is an auto-generated hash.

Example execution

./AuthenticationOneTimeLogin.sh -u administrator
One-time Login Successfully Created.
URL to login:
http://myserver.sup.local/webapps/login?action=one_time_login&ticket=01efc6ae-9d79-4678-bd58-2c7e6b608e95
Entry code:
1a140aa8-121c-4854-8538-c9bbc8e85a68
User to login:
administrator
Ticket will expire at:
Thursday, March 15, 2012 11:28:27 AM EDT
./AuthenticationOneTimeLogin.sh -u fflintstone -t 60
One-time Login Successfully Created.
URL to login:
http://myserver.sup.local/webapps/login?action=one_time_login&ticket=01efc6ae-9d79-4678-bd58-2c7e6b608e95
Entry code:
1a140aa8-121c-4854-8538-c9bbc8e85a68
User to login:
fflintstone
Ticket will expire at:
Thursday, March 15, 2012 11:43:35 AM EDT
./AuthenticationOneTimeLogin.sh -u brubble -t 60 -e letmein
One-time Login Successfully Created.
URL to login:
http://myserver.sup.local/webapps/login?action=one_time_login&ticket=01efc6ae-9d79-4678-bd58-2c7e6b608e95
Entry code:
letmein
User to login:
brubble
Ticket will expire at:
Thursday, March 15, 2012 11:43:35 AM EDT

Log in using the newly created ticket

  1. Copy the URL to login and paste it into a browser. You are presented with a One Time Login page.
  2. Copy or type the entry code supplied in the Entry code field.
  3. Select Login.