Navigation

Add Teams to a Project

Info With Circle IconCreated with Sketch.Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

Atlas limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization.

https://cloud.mongodb.com/api/atlas/v1.0

POST /groups/{GROUP-ID}/teams
Path ElementRequired/OptionalDescription
GROUP-IDRequired.The unique identifier for the project to which you are adding the team or teams.
FieldRequired/OptionalDescription
envelopeOptional.

A boolean that specifies whether or not to wrap the response in an envelope.

Defaults to false.

prettyOptional.

A boolean that specifies whether or not to return a "pretty-printed" JSON document.

Defaults to false.

Specify an array of documents, where each document represents one team you want to associate to the project. You must specify an array even if you are only associating a single team to the project.

NameTypeDescription
teamIdstring

The unique identifier of the team you want to associate with the project. You must specify a teamId of an existing team, and your team and project must share the same parent organization.

You can use the Get All Teams endpoint to obtain the list of teamIds in an organization.

roleNamesstring array

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team.

The following are the valid roles and their associated mappings:

Role NamesProject Roles
GROUP_OWNERProject Owner
GROUP_CLUSTER_MANAGERProject Cluster Manager
GROUP_DATA_ACCESS_ADMINProject Data Access Admin
GROUP_DATA_ACCESS_READ_WRITEProject Data Access Read/Write
GROUP_DATA_ACCESS_READ_ONLYProject Data Access Read Only
GROUP_READ_ONLYProject Read Only

The response JSON document includes an array of result objects, an array of link objects, and a count of the total number of result objects retrieved.

NameTypeDescription
resultsobject arrayIncludes one object for each item detailed in the results array section.
linksobject arrayIncludes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCountnumberCount of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

Each element in the result array is one team assigned to the project.

NameTypeDescription
linksobject array

This array includes one or more links to sub-resources and/or related resources.

The relations between URLs are explained in the Web Linking Specification.

roleNamesstring arrayArray of project roles assigned to the team.
teamIdstringThe unique identifier for the team.
curl -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/teams?pretty=true" \
--data '[ { "teamId" : "{TEAM-ID}", "roleNames" : [ "GROUP_OWNER" ] } ]'
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/teams",
"rel": "self"
}
],
"results": [
{
"links" : [
{
"href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/teams/{TEAM-ID}",
"rel" : "self"
}
],
"roleNames": [ "GROUP_OWNER" ],
"teamId": "{TEAM-ID}"
}
],
"totalCount": 1
}
Give Feedback