Links

Team settings

This reference describes your team settings on the Instruqt platform, which allow you to manage and customize the platform. Team settings can be found in the sidebar menu on the left.
Instructions for editing branding and managing team members have moved.

Set team settings

The following settings are available in the team settings menu on the left:
  • API keys
  • Track limits
  • Webhooks
  • Hot Start

API keys

The API keys setting holds an API key (or API token) that external systems can use to access tracks. For example, an CI/CD system that automatically tests tracks. To regenerate an API key and copy it to the clipboard:
🌐 Web UI
  1. 1.
    Click Team settings > API keys. ↳ Instruqt shows the Manage API keys page.
  2. 2.
    Click Regenerate API Key. ↳ The API Key field shows the new API key.
  3. 3.
    Click Copy to clipboard.
Now you can move over to your external system and apply the copied API key.

Track limits

Track limits allow you to set a play limit for public track plays. Public plays are all plays through embeds, or through open-ended invites (without restrictions). Plays from team members, and plays from track invites that have limits on the amount of people that can consume the invite do not count towards these limits.
Per track, you can configure limits per:
  • calendar month;
  • rolling month (last 30 days);
  • IP-per-hour.
The per-IP-per-hour setting limits the total number of plays a single IP address can do per hour for the configured track. When hosting a workshop where the users are on the same network (e.g. during a conference), you can either use an invited with a maximum number of claims, or temporarily increase the number of plays per IP.
You can define team wide defaults at the top of the page. If a track doesn't have it's own settings, these defaults are applied.
🌐 Web UI
  1. 1.
    Click Team settings > Track limits. ↳ Instruqt shows the Manage track limits page with all your tracks_._
  2. 2.
    Set the defaults for the entire team, and click Save.
  3. 3.
    Per track, override the team default limits, and click Save.

Webhooks

See the topic Webhooks for details on this setting.

Hot Start

See the topic Hot start a sandbox for details on this setting.

SSO

SSO allows configuration of an SSO connection for everyone on a team. With this configuration team members can authenticate to Instruqt by using the team login URL.
In order to support this your authentication provider must be configured to allow redirections to https://sso.play.instruqt.com/login/callback
Web UI
  1. 1.
    Navigate to Team Settings > SSO through the sidebar.
  2. 2.
    Select the applicable SSO provider for your team. Please contact the support team if the provider used by your team is not available.
  3. 3.
    Upon selecting a provider a drawer will appear for you to fill in the data related to your connection. In this example we are using Google Workspace. The values for Domain, Client ID and Client Secret must be obtained from your provider.
  4. 4.
    After setting up the provider the URL provided in the management page will work for all team members. Clicking the link will copy it to your clipboard. example login URL: https://play.instruqt.com/{team-name}/login
  5. 5.
    Upon navigating to the login URL users will get prompted to authenticate through the configured provider of your team.

Notes

  • Users are automatically assigned to the team the they authenticate with.
  • A user that wasn't part of the team yet will be assigned the Member role within that team.
  • Currently only one connection is allowed per team.