Get a Single Database User¶

On this page

Syntax
Examples
- Request
- Response

Base URL: https://cloud.mongodb.com/

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

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

Syntax¶

GET /api/atlas/v1.0/groups/{GROUP-ID}/databaseUsers/admin/{USERNAME}

Request Path Parameters¶

Parameter	Required/Optional	Description
`GROUP-ID`	Required.	The unique identifier for the group.
`USERNAME`	Required.	The username to retrieve

Request Query Parameters¶

Field Required/Optional Description

envelope

Optional.

A boolean that specifies whether or not to wrap the response in an envelope.

Defaults to false.

pretty

Optional

A boolean that specifies whether or not to return a “pretty-printed” JSON document.

Defaults to false.

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response Elements¶

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

Name	Description
`databaseName`	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.
`links`	One or more links to sub-resources and/or related resources.
`groupId`	ID of the Atlas group the user belongs to.
`username`	The username for authenticating to MongoDB.
`roles`	An array of the user’s roles and the database on which the user has each role. 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.databaseName`	The 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`	The name of the role. The possible 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`

Examples¶

Request¶

Important

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

curl -i -u "username:apiKey" --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/databaseUsers/admin/ellen"

Response¶

HTTP/1.1 200 OK

{
  "databaseName" : "admin",
  "groupId" : "5356823b3794dee37132bb7b",
  "links" : [ ... ],
  "roles" : [ {
    "databaseName" : "admin",
    "roleName" : "readAnyDatabase"
  }, {
    "databaseName" : "marketing",
    "roleName" : "readWrite"
  }, {
    "databaseName" : "marketing",
    "roleName" : "backup"
  } ],
  "username" : "ellen"
}

← Get All Database Users Create a Database User →