• API >
• Public API Resources >
• Groups and Users >
• Users >
• Create a User

Create a User

Note

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. 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

Resource

copy

POST /users

Create a new user.

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Cloud Manager API resources. These are all optional.

Name	Type	Description	Default
pretty	boolean	Indicates whether the response body should be in a prettyprint format.	false
envelope	boolean	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: status HTTP response code envelope The expected response body	false

Request Body Parameters

All fields are required.

Name	Type	Description
username	string	Cloud Manager username.
password	string	Password. 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.
mobileNumber	string	Mobile number.
firstName	string	First name.
lastName	string	Last name.
roles	object array	Role assignments.
roles.groupId	string	The group ID in which the user has the specified role. Note that for the “global” roles (those whose name starts with GLOBAL_) there is no groupId since these roles are not tied to a group.
roles.roleName	string	The name of the role. Possible 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

Response

The HTTP 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 relations between URLs are explained in the Web Linking Specification.
mobileNumber	string	Mobile number of the Cloud Manager user.
roles	object array	Role assignments.
roles.groupId	string	The ID of the group in which the user has the specified role.
roles.orgId	string	The ID of the organization in which the user has the specified role.
roles.roleName	string	The 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_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
username	string	Cloud Manager username of the Cloud Manager user.

Example Request

copy

curl -u "username:apiKey" -H "Content-Type: application/json" --digest -i -X POST "https://cloud.mongodb.com/api/public/v1.0/users" --data '
{
  "username": "jane",
  "emailAddress": "jane.doe@mongodb.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "password": "M0ng0D8!:)",
  "roles": [{
    "groupId": "533daa30879bb2da07807696",
    "roleName": "GROUP_USER_ADMIN"
  },{
    "orgId" : "55555bbe3bd5253aea2d9b16",
    "roleName" : "ORG_MEMBER"
  }]
}'

Example Response

copy

HTTP/1.1 201 Created

{
  "id" : "533dc19ce4b00835ff81e2eb",
  "username" : "jane",
  "emailAddress" : "jane.doe@mongodb.com",
  "firstName" : "Jane",
  "lastName" : "Doe",
  "roles" : [ {
    "groupId" : "533daa30879bb2da07807696",
    "roleName" : "GROUP_USER_ADMIN"
  },{
    "orgId" : "55555bbe3bd5253aea2d9b16",
    "roleName" : "ORG_MEMBER"
  } ],
  "links" : []
}

←   Get a User by Name Update a User  →

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