Sign in

v1

latestOpenAPI 3.0.1CC BY-NC-SA 3.0 US2026-07-145251,1312.6 MB
Database Users

Return One Database User from One Project

Returns one database user that belong to the specified project.

get/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

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.

databaseNamestring required

The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be $external. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be admin.

usernamestring required
Example:SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName

Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:

Authentication MethodParameter NeededParameter Valueusername Format
AWS IAMawsIAMTypeROLE<abbr title="Amazon Resource Name">ARN</abbr>
AWS IAMawsIAMTypeUSER<abbr title="Amazon Resource Name">ARN</abbr>
x.509x509TypeCUSTOMERRFC 2253 Distinguished Name
x.509x509TypeMANAGEDRFC 2253 Distinguished Name
LDAPldapAuthTypeUSERRFC 2253 Distinguished Name
LDAPldapAuthTypeGROUPRFC 2253 Distinguished Name
OIDC WorkforceoidcAuthTypeIDP_GROUPAtlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name
OIDC WorkloadoidcAuthTypeUSERAtlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name
SCRAM-SHAawsIAMType, x509Type, ldapAuthType, oidcAuthTypeNONEAlphanumeric string

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Response

OK