Create an Atlas User¶
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 following resource creates a new Atlas user and assigns it to one or more of your Atlas projects and organizations.
Atlas sends an email to the selected users inviting them to join the project. Invited users do not have access to the project until they accept the invitation. Invitations expire after 30 days.
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 Atlas user membership to a maximum of 250 Atlas users per team.
Atlas limits Atlas user membership to 500 Atlas users per project and 500 Atlas users per organization, which includes the combined membership of all projects in the organization.
Atlas raises an error if an operation exceeds these limits.
You have an organization with five projects. Each project has 100 Atlas users. Each Atlas user belongs to only one project. You cannot add any Atlas users to this organization without first removing existing Atlas users from the organization membership.
Create a new user.
Resource¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
POST /users
Request Path Parameters¶
This endpoint does not use HTTP request path parameters.
Request Query Parameters¶
This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.
Name | Type | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a
prettyprint format. | false | ||||||
envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON envelope. This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes:
| false |
Request Body Parameters¶
Body Parameter | Type | Necessity | Description |
---|---|---|---|
country | string | Required | ISO-3166-1 alpha 2 country code of the Atlas user's country of
residence. |
emailAddress | string | Required | Atlas user's email address. |
firstName | string | Required | Atlas user's first name. |
id | string | Required | Unique identifier for the Atlas user. |
lastName | string | Required | Atlas user's last name. |
links | array of objects | Required | One or more links to sub-resources and/or related resources. The relation-types between URL |