Navigation

Create a Team

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.

Important With Circle IconCreated with Sketch.Important

Atlas limits the number of teams to a maximum of 250 teams per organization.

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

POST /orgs/{ORG-ID}/teams
Path ElementRequired/OptionalDescription
ORG-IDRequired.The unique identifier for the organization you want to associate the team with.
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.

NameTypeDescription
namestringThe name of the team you want to create.
usernamesarray of stringsUsernames to add to the new team.
NameTypeDescription
idstringThe unique identifier for the team.
namestringThe name of the organization associated with the team.
usernamesarray of stringsUsernames added to the new team.
linksobject arrayOne or more links to sub-resources and/or related resources. The relation-types between URL s are explained in the Web Linking Specification.
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/orgs/{ORG-ID}/teams/" \
--data '{ "name" : "myNewTeam", "usernames": ["user1", "user2", "user3"] }'
{
"id": "{TEAM-ID}",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}",
"rel": "self"
}
],
"name": "myNewTeam",
"usernames": ["user1", "user2", "user3"]
}
Give Feedback