Navigation

Add Teams to a Project

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 uses HTTP Digest Authentication. Provide your Atlas username and API key as the username and password when constructing the HTTP request.

For complete documentation on configuring 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.

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

Syntax

POST /groups/{GROUP-ID}/teams

Request Path Parameters

Path Element Required/Optional Description
GROUP-ID Required. The unique identifier for the project to which you are adding the team or teams.

Request Query Parameters

Field Required/Optional Description
envelope Optional.

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

Defaults to false.

pretty Optional.

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

Defaults to false.

Request Body Parameters

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.

Name Type Description
teamId string The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
roleNames array

Each object 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 valid roles and their associated mappings are:

Response

Response Document

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.

Name Type Description
results object array This array includes one object for each item detailed in the results array section.
links object 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.
totalCount number The count 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.

results array

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

Name Type Description
links object 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.

roleNames string array Array of project roles assigned to the team.
teamId string The unique identifier for the team.

Example

Request

curl -u "username:apiKey" --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}", "roles" : [ { "roleName" : "GROUP_OWNER" } ] } ]'

Response

{
 "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"
           }
         ]
         "rolesNames": [ "GROUP_OWNER" ],
         "teamId": "{TEAM-ID}"
     }
 ],
 "totalCount": 1
}