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.
The following settings are available in the team settings menu on the left:
- API keys
- Track limits
- Webhooks
- Hot Start
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.Click Team settings > API keys. ↳ Instruqt shows the Manage API keys page.
- 2.Click Regenerate API Key. ↳ The API Key field shows the new API key.
- 3.Click Copy to clipboard.
Now you can move over to your external system and apply the copied API key.
Track limits allow you to set a monthly play limit per track for embedded plays. (Plays from track invites do not count toward this limit).
🌐 Web UI
- 1.Click Team settings > Track limits. ↳ Instruqt shows the Manage track limits page with all your tracks.
- 2.In the Play limit field of the track you want to limit, enter the number of embedded plays you want to allow per month. ↳ Notice that the corresponding Save button turns red after you enter a number.
- 3.Click Save.
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. This feature is enabled for teams on request, please contact the support team for more information.
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.Navigate to Team Settings > SSO through the sidebar.
- 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.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.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.Upon navigating to the login URL users will get prompted to authenticate through the configured provider of your team.
- 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.
Last modified 1mo ago