atlas api mongoDbCloudUsers listProjectUsers

envelope

false

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.

"flattenTeams" : false

false

Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If "flattenTeams" : false, this resource returns only users with a role in the project. If "flattenTeams" : true, this resource returns both users with roles in the project and users who belong to teams with roles in the project.

string

true

Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has 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.

false

help for listProjectUsers

false

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

"includeOrgUsers": false

false

Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If "includeOrgUsers": false, this resource returns only users with a role in the project. If "includeOrgUsers": true, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.

int

false

Number of items that the response returns per page.

string

false

Flag that indicates whether to filter the returned list by users organization membership status. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions.

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

int

false

Number of the page that displays the current set of the total objects that the response returns.

false

Flag that indicates whether the response body should be in the prettyprint format.

string

false

Email address to filter users by. Not supported in deprecated versions.

string

false

api version to use when calling the api call [options: "2023-01-01", "2025-02-19"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-02-19".