Skip to main content

API Testing Project Settings

Project settings allow you to view the access to projects that was defined when the project was created, and configure project details such as name, description, and tags, and delete projects. You can also add email addresses to receive notifications about tests in a project.

Project settings

What You'll Need​

note

Sauce Labs Team Management features are available for Enterprise Plans only.

Project Access Levels and User Scenarios​

Access to a project is assigned when the project is created. You can assign the following access levels to a project:

  • Team Access: Available if an organization admin has set up teams in Team Management. Users must be a member of the assigned team or an organization admin to access the project.
  • Organization Access: Everyone that can access the organization.

The type of project access users have and can configure for the projects they create is based on the following user scenarios:

  • Team Member: Users who are a member of a team. They can work in projects with access assigned to the team that they are a member of and also projects with organization-wide access. They cannot view projects with access assigned to teams they are not a member of. When creating a project, they will have the option to set the project access to the team that they are a member of or organization-wide access.
  • Organization Admin: Organization Admins can create and interact with all data in all projects across their organization.
tip

You can view the access set for projects on the Projects page.
New user UI

Create a Project​

You create projects and define project settings on the Projects page, and edit project settings on the Settings > General > Project details page.

  1. In API Testing, on the Projects page, click Create Project.
  2. Select an option in the Create from dropdown.
  3. Optionally, select one or more Tags, or click Add custom tag to add a new tag.
  4. Optionally, enter a Description of the project.
  5. Optionally, enter Notes about the project.
  6. Select the Access level for the project. If you are a team member you can select your team or organization-wide access. If you are an organization admin, you can select any team or organization-wide access. This selection cannot be changed once the project is saved.
  7. Click Save.

Manage Access to Projects​

Once a project has been created and saved, the access level (team or organization-wide access) is uneditable.

If an organization admin deletes a team from Sauce Labs Accounts > Team Management before managing project access in API Testing, the access level defaults to Organization because the access setting is required. However, the project will still be available only to the original team and does not change to organization-wide access.

If you need to change access to a project, you have the following options.

Update Teams in Sauce Labs Accounts > Team Management​

If access is assigned to a team, you can add or remove team members from the team, which is outside of APIT in the Account area in Sauce Labs (go to Accounts > Team Management). You must be an organization admin to work with teams in Team Management.

Update Project Access in API Testing​

You can create a new project with the access you want, and then delete or rename the original project as follows. You must have team access to the team you want to configure, or be an organization admin to do this.

  1. Create a new project with the access (team or organization) you want.
  2. Export the tests from the original project and import them to the new project.
  3. Then either delete the original project or rename it to indicate it has been archived.
    note

    Make sure to update any test schedules for tests in the archived project so that tests are not run automatically.

Email Notifications​

You can configure one or more email addresses to be notified when tests in a project are failing.

Email notifications are triggered for failing tests. When a test starts failing, an email with "Incident started" included in the subject line is sent to each address configured to receive notifications for a project. A new email notification will be sent after 30 minutes if the test is still failing. The follow up email will include "Incident in progress" in the subject line. This notification is sent only if tests run less than every 30 minutes. When test execution passes, an email is sent with "Incident resolved" in the subject line.

To enable email notifications:

  1. In API Testing, on the Projects page, under a project name, click Settings.
  2. In the left nav, click Notifications.
  3. In the email address field, enter an address. To add more email addresses, click + New Email.
  4. Click Save changes.
    Dashboard Pic 1.5
tip

Use the Fact component in your API tests to control the behavior of email notifications. This can be useful if you're testing in multiple environments. For more information, see Fact.

Connectors​

See PagerDuty and Webhook Connectors for more information.

Delete a Project​

To delete a project:

  1. In API Testing, on the Projects page, under a project name, click Settings.
  2. On the Settings page, in the left nav, click Danger Zone.
  3. Click Delete project.