Get an Atlas User by Name¶
On this page
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 Administration 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 Get Started with the Atlas Administration API.
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 Administration 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:
| 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 | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
country | string | ISO-3166-1 alpha 2 country code of the country in which the Atlas
user resides. | ||||||||||||||||||||||||||
emailAddress | string | Email address that the Atlas user possesses. | ||||||||||||||||||||||||||
firstName | string | First or given name that identifies the Atlas user. | ||||||||||||||||||||||||||
id | string | Unique 24-hexidecimal digit string that identifies the Atlas
user. | ||||||||||||||||||||||||||
lastName | string | Last name, family name, or surname that identifies the Atlas
user. | ||||||||||||||||||||||||||
links | array | One or more uniform resource locators that link to sub-resources and/or related resources. The Web Linking Specification explains the relation-types between URLs. | ||||||||||||||||||||||||||
mobileNumber | string | Mobile or cell phone number that the Atlas user possesses. | ||||||||||||||||||||||||||
password | string | String of eight or more characters that authenticates the Atlas user specified with username. Atlas doesn't return this parameter except in response to creating a new user. You can't update the password after it has been created. The user must log into Atlas to update their password. | ||||||||||||||||||||||||||
roles | array | List of Atlas Organizations or Projects to
which you assigned the Atlas user and the Atlas
role has for the associated organization or
project. You can specify either roles.orgId or
roles.groupId per entry. | ||||||||||||||||||||||||||
roles.groupId | string | Unique 24-hexidecimal digit string that identifies the project
in which the user has the specified roles.roleName. | ||||||||||||||||||||||||||
roles.orgId | string | Unique 24-hexidecimal digit string that identifies the
organization in which the user has the specified
roles.roleName. | ||||||||||||||||||||||||||
roles.roleName | string | Label that identifies the assigned grouping of Atlas privileges. When associated to roles.orgId, the valid roles and their mappings include:
When associated to roles.groupId, the valid roles and their mappings include:
| ||||||||||||||||||||||||||
teamIds | array | Unique identifiers for each team to which
the user belongs. | ||||||||||||||||||||||||||
username | string | Email address that identifies the Atlas user in
RFC 5322 format You can't modify the
username after it has been created. |
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¶
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
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 }