Get an Atlas User by ID¶
Retrieve a Atlas user's profile using their unique identifier. You cannot use this endpoint to return information on an API Key. To return information on an API Key, use the Get One API Key endpoint.
You can always retrieve your own user account.
If you are the owner of an Atlas organization or project, you can also retrieve the user profile for any user with membership in that organization or project.
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.
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
.
Resource¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
GET /users/{USER-ID}
Request Path Parameters¶
Path Parameter | Type | Necessity | Description |
---|---|---|---|
USER-ID | string | Required | Unique identifier of the user that you want to retrieve. If you know the user's Atlas username, use the /users/byName/{USER-NAME} endpoint to retrieve the user's profile and unique identifier. |
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:
| 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 |