- API >
- API Resources >
- Projects
Get All Users in One 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 /groups/{PROJECT-ID}/users
Request Parameters¶
Request Path Parameters¶
Path Parameter | Type | Necessity | Description |
---|---|---|---|
PROJECT-ID | string | Required | Unique identifier for the group. |
Request Query Parameters¶
Name | Type | Necessity | Description |
---|---|---|---|
flattenTeams | boolean | Optional | Flag that indicates whether the returned list should include users who belong to a team that is assigned a role in this project. You might not have assigned the individual users a role in this project.
The default value is |
includeOrgUsers | boolean | Optional | Flag that indicates whether the returned list should include
users with implicit access to the project through the
The default value is |
Request Body Parameters¶
This endpoint doesn't use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results | array of objects | One object for each item detailed in the results Embedded Document section. |
links | array of objects | One or more links to sub-resources and/or related resources. The relations between URL |