Create a Database User¶

On this page

Syntax
Example Request

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. The resource and corresponding endpoints use the term groups.

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

The Atlas API uses HTTP Digest Authentication. Provide your Atlas username as the username and Atlas API key as the password as part of the HTTP request.

This endpoint requires that the Atlas user has the Owner role. To view the available Atlas users, click on Users & Teams in the left-hand navigation.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

Atlas supports a maximum of 100 MongoDB users per Atlas project.

Note

If you require more than 100 MongoDB users on a project, please contact Atlas support.

Syntax¶

copy

POST /api/atlas/v1.0/groups/{GROUP-ID}/databaseUsers

Request Path Parameters¶

Path Parameter	Necessity	Description
`GROUP-ID`	Required	Unique identifier for the project.

Request Query Parameters¶

The following query parameters are optional:

Query Parameter	Type	Description	Default
`pretty`	boolean	Displays response in a prettyprint format.	`false`
`envelope`	boolean	Specifies whether or not to wrap the response in an envelope.	`false`

Request Body Parameters¶

Body Parameter Type Necessity Description

databaseName string Required The user’s authentication database. A user must provide both a username and authentication database to log into MongoDB. In Atlas deployments of MongoDB, the authentication database is always the admin database.

deleteAfterDate

string

Optional

Timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the user. The specified date must be in the future and within one week of the time you make the API request.

Note

You may include an ISO 8601 time zone designator to ensure that the expiration date occurs with respect to the local time in the specified time zone.

labels

array of documents

Optional

Array containing key-value pairs that tag and categorize the database user.

Each key and value has a maximum length of 255 characters.

"labels": [
   {
     "key": "example key",
     "value": "example value"
   }
 ]

ldapAuthType

string

Optional

Method by which the provided username is authenticated. If no value is given, Atlas uses the default value of NONE.

Accepted values include:

`NONE`	Atlas authenticates this user through SCRAM-SHA, not LDAP.
`USER`	LDAP server authenticates this user through the user’s LDAP user.
`GROUP`	LDAP server authenticates this user using their LDAP user and authorizes this user using their LDAP group. To learn more about LDAP security, see Set up User Authentication and Authorization with LDAP.

x509Type

string

Optional

X.509 method by which the provided username is authenticated. If no value is given, Atlas uses the default value of NONE.

The accepted types are:

NONE The user does not use X.509 authentication.

MANAGED

The user is being created for use with Atlas-managed X.509.

Externally authenticated users can only be created on the $external database.

CUSTOMER

The user is being created for use with Self-Managed X.509. Users created with this x509Type require a Common Name (CN) in the username field. For more information, see RFC 2253.

Externally authenticated users can only be created on the $external database.

groupId string Required Unique identifier of the Atlas project to which the user belongs.

roles

string array

Required

Array of this user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well.

Note

The available privilege actions for custom MongoDB roles support a subset of MongoDB commands. See Unsupported Commands in M10+ Clusters for more information.

Important

If a user is assigned a custom MongoDB role, they cannot be assigned any other roles.

roles

.collectionName

string

Required

Collection for which the role applies.

You can specify a collection for the read and readWrite roles. If you do not specify a collection for read and readWrite, the role applies to all collections in the database (excluding some collections in the system. database).

Note

When applied to a collection, the read and readWrite roles in Atlas differ slightly from the built-in MongoDB read and readWrite roles.

In Atlas, read provides the following collection-level actions:

In Atlas, readWrite provides the same actions as read, as well as the following additional collection-level actions:

roles

.databaseName

string

Required

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

roles

.roleName

string

Required

Name of the role. This value can either be a built-in role or a custom role.

The following accepted values of role are restricted to the admin database:

atlasAdmin
readWriteAnyDatabase
readAnyDatabase
clusterMonitor
backup
dbAdminAnyDatabase
enableSharding

This role is specific to MongoDB databases managed by Atlas. The role allows the user to enable sharding on a database and to shard a collection.

The following accepted values of role can be applied to a specific database:

dbAdmin
read
readWrite

The following accepted values of role can be applied to a specific collection:

read
readWrite

If you do not specify a collection for the read and readWrite roles, the roles apply to all collections (excluding some system. collections) in the database.

Note

If you specify a custom role name in this field, the roles.databaseName field must be admin.

password string Conditional The user’s password. Required if x509Type is NONE. This field is not included in the entity returned from the server.

username string Required Username for authenticating to MongoDB.

Response Elements¶

If you set the query element envelope to true, the response is wrapped by the content object.

Response Element Type Description

databaseName string The user’s authentication database. A user must provide both a username and authentication database to log into MongoDB. In Atlas deployments of MongoDB, the authentication database is always the admin database.

deleteAfterDate string Timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the user. This field is only present if an expiration date was specified when creating the entry.

groupId string Unique identifier of the Atlas project to which the user belongs.

labels array of documents Array containing key-value pairs that tag and categorize the database user.

ldapAuthType

string

Method by which the specified username is authenticated. If no value is given, Atlas uses the default value of NONE.

Accepted values include:

`NONE`	Atlas authenticates this user through SCRAM-SHA, not LDAP.
`USER`	LDAP server authenticates this user through the user’s LDAP user.
`GROUP`	LDAP server authenticates this user using their LDAP user and authorizes this user using their LDAP group. To learn more about LDAP security, see Set up User Authentication and Authorization with LDAP.

x509Type

string

X.509 method by which the provided username is authenticated. If no value is given, Atlas uses the default value of NONE.

The possible types are:

NONE The user does not use X.509 authentication.

MANAGED

The user is being created for use with Atlas-managed X.509.

Externally authenticated users can only be created on the $external database.

CUSTOMER

The user is being created for use with Self-Managed X.509. Users created with this x509Type require a Common Name (CN) in the username field. To learn more, see RFC 2253.

Externally authenticated users can only be created on the $external database.

links document array One or more links to sub-resources and/or related resources.

roles string array Array of this user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well.

roles

.collectionName

string

Collection on which the user has the specified role.

roles

.databaseName

string

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

roles

.roleName

string

Name of the role. The accepted values are:

atlasAdmin
readWriteAnyDatabase
readAnyDatabase
backup
clusterMonitor
dbAdmin
dbAdminAnyDatabase
enableSharding

This role is specific to MongoDB databases managed by Atlas. The role allows the user to enable sharding on a database and to shard a collection.
read
readWrite
A name of a custom MongoDB role

username string Username for authenticating to MongoDB.

Example Request¶

Request¶

Important

You must modify the following code block with the appropriate credentials and project ID.

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --include \
  --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/databaseUsers" \
  --data '
    {
     "databaseName": "admin",
     "password": "changeme123",
     "roles": [{
       "databaseName": "sales",
       "roleName": "readWrite"
     }, {
       "databaseName": "marketing",
       "roleName": "read"
     }],
     "username": "david"
    }'

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}

Response Body¶

copy

{
  "databaseName" : "admin",
  "groupId" : "5356823b3794dee37132bb7b",
  "labels" : [],
  "links" : [ ... ],
  "roles" : [ {
    "databaseName" : "sales",
    "roleName" : "readWrite"
  }, {
    "databaseName" : "marketing",
    "roleName" : "read"
  } ],
  "username" : "david",
  "ldapAuthType" : "NONE",
  "x509Type" : "NONE"
}

← Get a Single Database User Update a Database User →