Access Keys

Access keys are a set of unique and highly secure login credentials used to authenticate automated processes, such as scheduled imports of test files in Aware and data exports via SFTP (Secure File Transfer Protocol).

Prerequisites

To create access keys, you must meet the following requirements:

• Have the System Administrator role and/or the Manage Users right enabled.
• Have the Access Key feature enabled for your district. If you do not see the Access Keys tab when managing users in Web Management, contact your Account Manager or Eduphoria Support for more information about enabling this feature.

Creating an Access Key

Note: Eduphoria recommends creating a separate user account for each use case. Even if the user already has an Eduphoria account, create a separate login for the purpose of managing automation. This enhances security and provides better control of high-profile accounts. For instructions on how to complete this step of the process, see Creating User Accounts.

Step 1: Access Management.

Step 2: On the Organization tab, select Manage Users.

Step 3: In the Users list, search for and select the user you created for this purpose. 

Step 4: Select the Access Keys tab. 

Step 5: In the Comment field, enter a brief description of why you are creating the access key.

Step 6: Select Add.

Step 7: Save the Access key ID and Secret access key in a secure password manager. After exiting the screen, you will not be able to retrieve the Secret access key again. If you do not save this information, you will need to delete the old access key data and create a new one the next time you need to use it.

Using the Access Key to Import Test Files

Note: Importing test files via SFTP is only supported with built-in test types. Custom test types are not supported at this time. Check out the list of supported file types to learn more.

Step 1: Once the new user account and access key exist, go to the Rights tab and select the Import Test Files right to allow the user to import files to Aware.

Step 2: Open your preferred SFTP client. 

Note: Eduphoria recommends using command-line utilities to schedule and automate processes.

Step 3: Use the following information to connect.

• Server: sftp.schoolobjects.com
• Protocol: SFTP
• Username: [Access key ID]
• Password: [Secret access key]

Step 4: Once connected, you can upload files into the aware-test-import folder to transfer them to Aware. Upon successful import, test files can be located in Aware > Analysis Settings > Upload Test Files.

Rotating Access Keys

For security purposes, Eduphoria recommends rotating access keys at least once a year. After creating a new access key for the appropriate user account, update existing automated processes with the new access key. Delete the previous access key.