Sign in

v1

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

Return One MongoDB Cloud User by Username

Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint.

get/api/atlas/v2/users/byName/{userName}

Path parameters

userNamestring required

Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.

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