Get an Atlas User by Name¶

Retrieve a Atlas user's profile using their username. You cannot use this resource to return information on an API Key. To return information on an API Key, use the Get One API Key endpoint.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API 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.

Syntax¶

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

GET /users/byName/{USER-NAME}

Request Path Parameters¶

Path Parameter	Type	Necessity	Description
{USER-NAME}	string	Required	Atlas username. Must match the username provided as part of the HTTP Digest Authentication API request component.

Request Query Parameters¶

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

Name

Type

Necessity

Description

Default

pretty

boolean

Optional

Flag indicating whether the response body should be in a prettyprint format.

false

envelope

boolean

Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:


status	HTTP response code
envelope	Expected response body

false

Request Body Parameters¶

This endpoint doesn't use HTTP request body parameters.

Response¶

The JSON document contains each of the following elements:

Response Parameter

Type

Required

Description

country

string

Required

ISO-3166-1 alpha 2 country code of the Atlas user's country of residence.

emailAddress

string

Required

Atlas user's email address.

firstName

string

Required

Atlas user's first name.

id

string

Required

Unique identifier for the Atlas user.

lastName

string

Required

Atlas user's last name.

links

array of objects

Required

One or more links to sub-resources and/or related resources. The relation-types between URL s are explained in the Web Linking Specification.

mobileNumber

string

Required

Atlas user's mobile or cell phone number, if it is listed in the user's profile.

password

string

Required

Password. Atlas doesn't return this parameter except in response to creating a new user.

You cannot update the password via API once set. The user must log into Atlas and update their password from the Atlas console.

roles

array of objects

Required

Each object in the array represents either an Atlas organization or project the Atlas user is assigned to and the Atlas role has for the associated organization or project. You can specify either roles.orgId or roles.groupId per object.

roles.groupId

string

Required

unique identifier of the project in which the user has the specified roles.roleName.

roles.orgId

string

Required

unique identifier of the organization in which the user has the specified roles.roleName.

roles.roleName

string

Required

name of the role.

When associated to roles.orgId, the valid roles and their mappings are:

Role	Mapping
ORG_OWNER	`Organization Owner`
ORG_GROUP_CREATOR	`Organization Project Creator`
ORG_BILLING_ADMIN	`Organization Billing Admin`
ORG_READ_ONLY	`Organization Read Only`
ORG_MEMBER	`Organization Member`

When associated to roles.groupId, the valid roles and their mappings are:

Role	Mapping
GROUP_OWNER	`Project Owner`
GROUP_CLUSTER_MANAGER	`Project Cluster Manager`
GROUP_READ_ONLY	`Project Read Only`
GROUP_DATA_ACCESS_ADMIN	`Project Data Access Admin`
GROUP_DATA_ACCESS_READ_WRITE	`Project Data Access Read/Write`
GROUP_DATA_ACCESS_READ_ONLY	`Project Data Access Read Only`

teamIds

array of strings

Required

Unique identifiers for each team to which the user belongs.

username

string

Required

Atlas username. Must use email address formatting. You cannot modify the username once set.

Example Request¶

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --request GET "https://cloud.mongodb.com/api/atlas/v1.0/users/byName/john.doe@example.com"

Example Response¶

Response Header¶

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body¶

1 {
2   "country": "UK",
3   "emailAddress": "john.doe@example.com",
4   "firstName": "John",
5   "id": "5af1c27a0a7fa48c76d3a761",
6   "lastName": "Doe",
7   "links": [
8     {
9       "href": "https://cloud.mongodb.com/api/atlas/v1.0/users/5af1c27a0a7fa48c76d3a761",
10       "rel": "self"
11     },
12     {
13       "href": "https://cloud.mongodb.com/api/atlas/v1.0/users/5af1c27a0a7fa48c76d3a761/accessList",
14       "rel": "http://mms.mongodb.com/accessList"
15     }
16   ],
17   "mobileNumber" : "2125550198",
18   "roles": [
19     {
20       "orgId": "5af1c27a0a7fa48c76d3a762",
21       "roleName": "ORG_OWNER"
22     },
23     {
24       "groupId": "5af1c27a0a7fa48c76d3a763",
25       "roleName": "GROUP_OWNER"
26     }
27   ],
28   "teamIds": [
29     "5af1c27a0a7fa48c76d3a764"
30   ],
31   "username": "john.doe@example.com"
32 }

Give Feedback

← Get an Atlas User by ID Create an Atlas User →

1	{
2	"country": "UK",
3	"emailAddress": "john.doe@example.com",
4	"firstName": "John",
5	"id": "5af1c27a0a7fa48c76d3a761",
6	"lastName": "Doe",
7	"links": [
8	{
9	"href": "https://cloud.mongodb.com/api/atlas/v1.0/users/5af1c27a0a7fa48c76d3a761",
10	"rel": "self"
11	},
12	{
13	"href": "https://cloud.mongodb.com/api/atlas/v1.0/users/5af1c27a0a7fa48c76d3a761/accessList",
14	"rel": "http://mms.mongodb.com/accessList"
15	}
16	],
17	"mobileNumber" : "2125550198",
18	"roles": [
19	{
20	"orgId": "5af1c27a0a7fa48c76d3a762",
21	"roleName": "ORG_OWNER"
22	},
23	{
24	"groupId": "5af1c27a0a7fa48c76d3a763",
25	"roleName": "GROUP_OWNER"
26	}
27	],
28	"teamIds": [
29	"5af1c27a0a7fa48c76d3a764"
30	],
31	"username": "john.doe@example.com"
32	}