• API >
• Public API Resources >
• Projects and Users >
• Projects >
• Add Teams to a Project

Add Teams to a Project

Note

Groups and projects are synonymous terms. Your {PROJECT-ID} is the same as your project id. For existing groups, your group/project id remains the same. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

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

Syntax

copy

POST /groups/{PROJECT-ID}/teams

Request Path Parameters

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

Request Query Parameters

The following query parameters are optional:

Name	Type	Necessity	Description	Default
pageNum	number	Optional	One-based integer that returns a subsection of results.	1
itemsPerPage	number	Optional	Number of items to return per page, up to a maximum of 500.	100
pretty	boolean	Optional	Flag that indicates whether the response body should be in a prettyprint format.	false
envelope	boolean	Optional	Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope : true in the query. For endpoints that return a list of results, the results object is an envelope. Cloud Manager adds the status field to the response body.	false

Request Body Parameters

Specify an array of documents, where each document represents one team you want to associate to the project. Each document in the array must contain the following fields:

Name	Type	Description
roleNames	array	Each object in the array represents a project role you want to assign to the team. The valid roles and their associated mappings are: GROUP_OWNER - Project Owner GROUP_READ_ONLY - Project Read Only GROUP_DATA_ACCESS_ADMIN - Project Data Access Admin GROUP_DATA_ACCESS_READ_WRITE - Project Data Access Read/Write GROUP_DATA_ACCESS_READ_ONLY - Project Data Access Read Only GROUP_MONITORING_ADMIN - Project Monitoring Admin GROUP_BACKUP_ADMIN - Project Backup Admin GROUP_AUTOMATION_ADMIN - Project Automation Admin GROUP_USER_ADMIN - Project User Admin
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.

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	array	Array includes one object for each item detailed in the results Embedded Document section.
links	array	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	Integer 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 Embedded Document

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

Name	Type	Description
links	array	One or more links to sub-resources and/or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.
roleNames	array	Array of project roles assigned to the team. The valid roles and their associated mappings are: GROUP_OWNER - Project Owner GROUP_READ_ONLY - Project Read Only GROUP_DATA_ACCESS_ADMIN - Project Data Access Admin GROUP_DATA_ACCESS_READ_WRITE - Project Data Access Read/Write GROUP_DATA_ACCESS_READ_ONLY - Project Data Access Read Only GROUP_MONITORING_ADMIN - Project Monitoring Admin GROUP_BACKUP_ADMIN - Project Backup Admin GROUP_AUTOMATION_ADMIN - Project Automation Admin GROUP_USER_ADMIN - Project User Admin

Example Request

copy

curl -u "username:apiKey" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams?pretty=true" \
 --data '[ { "teamId" : "{TEAM-ID}", "roles" : [ { "roleName" : "GROUP_OWNER" } ] } ]'

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

copy

{
   "links": [
       {
           "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams",
           "rel": "self"
       }
   ],
   "results": [
       {
           "links": [
               {
                   "href": "https://cloud.mongodb.com/api/pubic/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}",
                   "rel": "self"
               }
           ],
           "roleNames": [ "GROUP_OWNER" ],
           "teamId": "{TEAM-ID}"
       }
   ],
   "totalCount": 1
 }

←   Get All Teams in One Project Remove One Team From One Project  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.