- API >
- Public API Resources >
- Projects and Users >
- Users >
- Create One User
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.
Resource¶
Base URL: https://cloud.mongodb.com/api/public/v1.0
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:
|
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:
|
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 |
object 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
|
||||||||||||||||||||||||||||||
username |
string | Username of the Cloud Manager user. |