- API >
- API Resources >
- Teams
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
Atlas limits the number of teams to a maximum of 250 teams per organization.
https://cloud.mongodb.com/api/atlas/v1.0
Syntax¶
POST /orgs/{ORG-ID}/teams
Request Path Parameters¶
| Path Element | Required/Optional | Description |
|---|---|---|
ORG-ID | Required. | The unique identifier for the organization you want to associate the team with. |
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 |
pretty | Optional. | A boolean that specifies whether or not to return a "pretty-printed" JSON document. Defaults to |
Request Body Parameters¶
| Name | Type | Description |
|---|---|---|
name | string | The name of the team you want to create. |
usernames | array of strings | Usernames to add to the new team. |
Response¶
| Name | Type | Description |
|---|---|---|
id | string | The unique identifier for the team. |
name | string | The name of the organization associated with the team. |
usernames | array of strings | Usernames added to the new team. |
links | object array | One or more links to sub-resources and/or related resources. The relation-types between URL s are explained in the Web Linking Specification. |
Example¶
Request¶
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"] }'
Response¶
{ "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