Get a Single Database User¶

On this page

Syntax
Examples
- Request
- Response

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 and API key as the username and password when constructing the HTTP request.

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

Syntax¶

copy

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 project.
`USERNAME`	Required.	The username to retrieve

Request Query Parameters¶

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

Name	Type	Description	Default
`pretty`	boolean	Display response in a prettyprint format.	`false`
`envelope`	boolean	Specifies whether or not to wrap the response in an envelope.	`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 project 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.collectionName`	The collection on which the user has the specified role.
`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 project ID.

copy

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

Response¶

copy

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 →