Navigation
You were redirected from a different version of the documentation. Click here to go back.

Create One User

On this page

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.

Create a new user. By default, any non-global organization and project roles in the payload send users an invitation to the organization or project first. You can add users directly to an organization or project only if you set the mms.user.bypassInviteForExistingUsers setting to true.

Resource

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

copy 
POST /users

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

The following query parameters 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 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 one result, the response body includes:

Name Description
status HTTP response code
envelope Expected response body
false

Request Body Parameters

All fields are required.

Name Type Description
username string Username of the Cloud Manager user. Must be a valid email address.
password string

Password of the Cloud Manager user.

Note

This field is not included in the entity returned from the server. It can only be sent in the entity body when creating a new user.
emailAddress string Email address of the Cloud Manager user.
mobileNumber string Mobile telephone number of the Cloud Manager user.
firstName string First name of the Cloud Manager user.
lastName string Last name of the Cloud Manager user.
country string Primary country where the Cloud Manager user is based. Must match a two-letter ISO 3661-1 country code.
roles object array Role assignments of the Cloud Manager user.
roles.orgId string Unique identifier of the organization in which the Cloud Manager user has the specified role.
roles.groupId string Unique identifier of the group in which the Cloud Manager user has the specified role.
roles.roleName string

Name of the role. Accepted values are:

Value Description
ORG_MEMBER Organization Member
ORG_READ_ONLY Organization Read Only
ORG_BILLING_ADMIN Organization Billing Admin
ORG_GROUP_CREATOR Organization Project Creator
ORG_OWNER Organization Owner
GROUP_ATLAS_ADMIN Project Admin (Atlas)
GROUP_AUTOMATION_ADMIN Project Automation Admin
GROUP_BACKUP_ADMIN Project Backup Admin
GROUP_MONITORING_ADMIN Project Monitoring Admin
GROUP_OWNER Project Owner
GROUP_READ_ONLY Project Read Only
GROUP_USER_ADMIN Project User Admin
GROUP_BILLING_ADMIN Project Billing Admin
GROUP_DATA_ACCESS_ADMIN Project Data Access Admin
GROUP_DATA_ACCESS_READ_ONLY Project Data Access Read Only
GROUP_DATA_ACCESS_READ_WRITE Project Data Access Read/Write

Response

The JSON document contains each of the following elements:

Name Type Description
emailAddress string Email address of the Cloud Manager user.
firstName string First name of the Cloud Manager user.
id string Unique identifier of the Cloud Manager user.
lastName string Last name of the Cloud Manager user.
links object array Links to related sub-resources. All links arrays in responses include at least one link called self. The relationship between URLs are explained in the Web Linking Specification.
mobileNumber string Mobile number of the Cloud Manager user.
roles empty array Role assigned to the Cloud Manager user.
roles
.groupId
 string Unique identifier for the project in which the user has the specified role.
roles
.orgId
 string Unique identifier for the organization in which the user has the specified role.
roles
.roleName
 string

Name of the role. Accepted values are:

Note

The users resource returns all the roles the user has in both Cloud Manager and MongoDB Atlas.

Value Description
ORG_MEMBER Organization Member
ORG_READ_ONLY Organization Read Only
ORG_BILLING_ADMIN Organization Billing Admin
ORG_GROUP_CREATOR Organization Project Creator
ORG_OWNER Organization Owner
GROUP_AUTOMATION_ADMIN Project Automation Admin
GROUP_BACKUP_ADMIN Project Backup Admin
GROUP_MONITORING_ADMIN Project Monitoring Admin
GROUP_OWNER Project Owner
GROUP_READ_ONLY Project Read Only
GROUP_USER_ADMIN Project User Admin
GROUP_DATA_ACCESS_ADMIN Project Data Access Admin
GROUP_DATA_ACCESS_READ_ONLY Project Data Access Read Only
GROUP_DATA_ACCESS_READ_WRITE Project Data Access Read/Write
username string Username of the Cloud Manager user.

Example Request

copy 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/users" \
     --data '
       {
         "username": "jane.doe@mongodb.com",
         "emailAddress": "jane.doe@mongodb.com",
         "firstName": "Jane",
         "lastName": "Doe",
         "password": "M0ng0D8!:)",
         "country" : "US",
         "roles": [{
           "groupId": "533daa30879bb2da07807696",
           "roleName": "GROUP_USER_ADMIN"
         },{
           "orgId" : "55555bbe3bd5253aea2d9b16",
           "roleName" : "ORG_MEMBER"
         }]
       }'

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 201 Created
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 
{
  "id" : "533dc19ce4b00835ff81e2eb",
  "username" : "jane.doe@mongodb.com",
  "emailAddress" : "jane.doe@mongodb.com",
  "firstName" : "Jane",
  "lastName" : "Doe",
  "roles" : [],
  "links" : []
}

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