The Sauce Labs Cookbook

Sauce Headless

Front End Performance Testing

Insights

External Resources

More Info


Page tree
Skip to end of metadata
Go to start of metadata

ENTERPRISE PLANS ONLY

The following endpoints allow you to manage teams:

What You'll Need

  • Access to Sauce Labs most recent Team Management features 
    • To verify you have access, click your account name in the user interface. You should see your org name followed by panels for Concurrency, Peak VM Concurrency, and Tests By Day. 
    • If you do not have this configured for your site, speak to your Customer Success Manager for help migrating  
  • The data center endpoint you're working with; for more information, see Data Center Endpoints

Base URL

The base URL for the endpoints described in this doc is SAUCE_DC/team-management/ where SAUCE_DC is the data center you're working with. For more information, see Data Center Endpoints.

List Teams

Get a list of all teams.

GET v1/teams/
Query Parameters

These parameters can be included in a URL query string.

name

optional


 Gets a team with this name

Create Team

Create a team.

POST v1/teams

Request Body

The request body should be a "application/json" encoded object containing these parameters:

name

required

The name for the new team

organization

required


The organization the team belongs to

settings

required

The Concurrency limit for the team

description

optional

A description of the team

 

Create Team With Concurrency

To create a new team with concurrency set to 100, the payload should look like this.

{
	name: "New Team",
	organization: "{ORGANIZATION_ID}"
	settings: {
		virtual_machines: 100
	}
}

Read Team

Get information about a team.

Get v1/teams/{id}/

Path Parameters

These parameters should be provided in the URL path. 

id

required

The ID of the team to read.

Update Team

Update information about a team.

Put v1/teams/{id}/

Path Parameters

These parameters should be provided in the URL path. 

id

required

The ID of the team to update.

Request Body

The request body should be a "application/json" encoded object containing these items.

ParameterDescription

name re

required

 The updated name for the team

settings req

required

 The updated concurrency limits for the team

description

optional

The description for the team




Partial Update Team

Update partial information about a team.

PATCH v1/teams/{id}/

Path Parameters

These parameters should be included in the URL path.

ParameterDescription

id r

required

The ID of the team to update

Request Body

The request body should be a "application/json" encoded object containing these items.

ParameterDescription

name 

optional

 The updated name of the team

settings 

optional

 The concurrency limits for the team

description

optional

The description for the team

Update Team Concurrency

To update the team's concurrency to 100 the payload, should look like below:

{
	settings: {
		virtual_machines: 100
	}
}

Delete Team

Delete a team.

DELETE /v1/teams/{id}/

Path Parameters

These parameters should be included in the URL path.

id

required

The ID of the team to delete.

 

Get Team Members

Gets a list of users who belong to a team. 

GET /v1/teams/{id}/members/

Path Parameters

These parameters should be included in the URL path.

id

required

The ID of the team you want to see the list of users for.

 

Reset Access Key

Reset access tokens for all members of a team. 

POST /v1/teams/{id}/reset-access-key/

Path Parameters

These parameters should be included in the URL path.

id

required

The ID of the team you want to reset the access token for.

 

Request Body

The request body should be a "application/json" encoded object containing these items.

ParameterDescription

name 

optional

 The name of the team

settings 

optional

 The concurrency limits for the team

description

optional

The description for the team