Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
Commands
/
api
/
mongoDbCloudUsers

atlas api mongoDbCloudUsers listOrganizationUsers

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Public Preview: please provide feedback at: Returns details about the pending and active MongoDB Cloud users associated with the specified organization.

To use this resource, the requesting Service Account or API Key must have the Organization Member role.

Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.

Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers.

For more information and examples, see the referenced API documentation linked above.

Syntax

Command Syntax
atlas api mongoDbCloudUsers listOrganizationUsers [options]

Options

Name
Type
Required
Description

--envelope

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.

-h, --help

false

help for listOrganizationUsers

--includeCount

false

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

--itemsPerPage

int

false

Number of items that the response returns per page.

--orgId

string

true

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.

--orgMembershipStatus

string

false

Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions.

--output

string

false

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

--output-file

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)

--pageNum

int

false

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

--pretty

false

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

--username

string

false

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

--version

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".

Inherited Options

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Examples

atlas api mongoDbCloudUsers listOrganizationUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE

Back

getUserByUsername

Next

listProjectUsers