Navigation

Get a Single Database User

On this page

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 a programmatic API public key and corresponding private 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. Unique identifier for the project.
USERNAME Required. Username to retrieve

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

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.

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.
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.
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:
username string Username for authenticating to MongoDB.

Examples

Request

Important

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

copy 
curl -i -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --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"
}

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