Managing Security Options

Your site's security is high on our priority list. This article reviews the options you have on the Security page of your site.


Site Password

Your learning site will be password protected until your site is launched or goes live. Users who attempt to visit your site's URL will land on a page indicating that the site is closed. To bypass this page, you must enter the site password, or sign in with valid credentials. For testing purposes, you can enter the site password in order to view and test the different user flows without being logged in.

Note

The site password is not related to your personal login credentials.

  1. From your homepage, select Settings > Security.
  2. Within the Passwords & Keys section, you will find your assigned site password. This password is randomly generated.
    SitePassword_ViewPassword_AdminView.png
  3. Go to your site URL and enter the password. Click Enter.
    SitePassword_LoginScreen_EndUserView.png 

    Tip

    We highly recommend using a private/incognito browser in order to test your site as a logged out user.

  4. From here, you are ready to start testing!

Tip

Removing the password protection from your site is the final step in setting up your custom domain (launching your site). You should not remove the password protection on your site until all configuration steps and QA are completed.

 

Reactivating Your Site Password

If you do happen to accidentally remove password protection before you're ready, please reach out to your Tech Success & Support to have this reapplied to your site.

Primary API Keys

Come here to view and copy your site's API key. For security purposes, your key is masked and you have the option to rotate your key as needed. You can generate up to two primary masked keys at a time, which have full admin permissions to your site.

  1. From your homepage, select Settings > Security.
  2. Find the Passwords & Keys section.
  3. Click Generate API Key.
    SecurityOptions_GenerateAPIKey_Cropped_AdminView.png
  4. Once an API Key has been generated, click the eye icon to view it and copy if needed.
    SecurityOptions_APIEyeIcon_AdminView.png
  5. If you would like to generate a 2nd API Key, click Generate API Key again. 
  6. Once you've generated two API Keys, you have the option to remove either API Key from your site by clicking the trash icon. 

    Warning

    Removing an API Key cannot be undone.

Ancillary API Keys

Ancillary API keys allow you to create multiple API keys for different uses and to assign each key a different scope of permissions. For security purposes, your key is visible only once, when it is initially created.

Create and Scope Keys

  1. From your homepage, select Settings > Security.
  2. Find the Ancillary Keys section.
  3. Click New API Key.
  4. Define a name for the key and select a user role (from Thought Industries' existing role-based permissions system) to define the permissions the API key has.

    • You can optionally create a new user role if no existing role exists with the desired permissions.

    Warning

    Ancillary keys are always main site keys. Associating a key with a Panorama role does not restrict that key to Panorama-only data. See the Understanding Panorama support article for more information about Client API keys

    Do not delete a role assigned to an ancillary key without first deleting or reassigning the key. Doing so will break the key and cause errors on the Security and Users tabs.

     

    Note

    You are solely responsible for testing to determine which role you want to assign to each key and we recommend thorough testing to ensure the permissions you select are appropriate for your particular use case. To assist you in defining permissions for each key, find the below table a summary of the permissions required for some common endpoints, with a focus on endpoints that expose user data.

  5. Utilize the key in Thought Industries REST API requests. Attempting to make a call to an endpoint that is not in scope for the user role will result in a 200 response with an error property in the body.

Common Endpoints and Manager User Role Permissions that Govern Access

This is not an exhaustive list of all endpoints. You are solely responsible for testing to determine which role you want to assign to each key and we recommend thorough testing to ensure the permissions you select are appropriate for your particular use case.
Endpoints Permissions

Users List

User Detail

Certify User

Recertify User

To allow access, enable any permission that allows access to the user list, e.g., Granting Access, Editing Basic Info, Creating Learners.

To restrict access, don’t give any permissions from the Learners section.

Create & Update User

Anonymize User

To allow access, enable the Editing Basic Info permission.

To restrict access, remove this permission.

List Content

To allow access, enable any permission from the Manage Content section.

To restrict access, don’t give any permissions from the Manage Content section.

List Meetings

List Locations

All ancillary keys have access to these endpoints.

Client List

Client License Detail

To allow access, enable any permission from the Panorama section.

To restrict access, don’t give any permissions from the Panorama section.

Create Client

To allow access, enable the Creating Clients permission.

To restrict access, remove this permission.

Delete Client

Delete Client License

To allow access, enable the Editing and Deleting Clients permission. For the Delete Client endpoint, the user role must be a main site level role (not a panorama role).

To restrict access, remove this permission.

List Assessment Attempts

Update Assessment Attempt Grade

Forgive Assessment Attempt

To allow access, enable the Managing Assessment Attempts permission.

To restrict access, remove this permission.

List Assignment Submissions

To allow access, enable the Manage Assignments permission and enable the role-level setting “Has Access To All Courses?”

To restrict access, remove this permission.

Logs - SSO and Avalara

To allow access, enable the “Manage School Settings” permission.

To restrict access, remove this permission.

Instructor Messages

Course Comments

Subscription Cancellations

Course Enrollments

Course Completions

Course Actions

Course Purchases

Course Views

Learning Path Actions

Product Purchases

Collection Purchases

A la carte Collection Purchases

Email Captures

Newsletter Signups

Assignment Submissions

Logins

Visits

Registration

Course Certifications

Assessment Attempts

Onboarding Survey Responses

Code Redemptions

Inactive Users

Awards

To allow access, enable the “View Reports” permission.

To restrict access, remove this permission.

Meeting Detail

To allow access, enable the Viewing Content Reports or Manage Roster permission.

To restrict access, remove both of these permissions.

 

Delete Keys

  1. From your homepage, select Settings > Security.
  2. Find the Ancillary Keys section.
  3. Click the trash icon to delete a key.

Configuring Frame Options

Your instance can be embedded onto another website, domain, or even app, via the use of these HTML tags: <frame>, <iframe>, or <object>. When you do this, we encourage you to set your Frame Options as described below.

  1. From the homepage, select Settings > Security.
  2. Find the section for Security Options.
  3. Choose one of two options from the drop-down::
    • Allow (not recommended)
    • Allow from Same Origin (recommended)
  4. Click Save.

Note

We recommend the Allow from Same Origin setting for your site’s Frame Options in order to prevent clickjacking attacks.

 

Tip

For more information on Frame Options, click here.

Volume Security Requests

Through various security measures, Thought Industries aims to prevent malicious actors from breaking into accounts. There are a few aspects that are good for you to know:

  1. Account Lockout Functionality
  2. Login Rate Limiting Functionality
  3. Volume Security Requests Setting
Account Lockout FunctionalityLogin Rate Limiting FunctionalityVolume Security Requests Setting

This behavior is always active on every site.

Objective: Prevent a malicious actor from breaking into a single account by guessing the password to that account.

Behavior: Locks out an individual user after 5 failed login attempts within 30 minutes to their account. It does not take IP address into account. After a user is locked out, they’ll see the existing login-too-many-attempts translation, which defaults to “You have made too many login attempts. Please try again in 30 minutes.”.

To enable the toggle and ignore volume requests based on IP:

  1. From the homepage, select Settings > Security.
  2. Find the section for Security Options.
  3. Options:
    • Disabled (default): Block users after high number of attempts from the same IP within 5 minutes. Users can log in again after the allotted number of minutes have passed (i.e., 5).
    • Enabled (ignore volume requests): Don’t block users based on IP.
  4. Enable the toggle Disable Security Volume Requests?.
  5. Click Save.
Was this article helpful?
1 out of 1 found this helpful

More resources

  • Academy

    Go from beginner to expert with hands-on training

  • Community

    Ask questions, swap ideas, and learn from people like you

  • Developer Docs

    Reference guides and code samples for developers