Docs Menu

Docs HomeLaunch & Manage MongoDBAtlas CLI

atlas dbusers list

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Return all database users for your project.

To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Command Syntax
atlas dbusers list [options]
Name
Type
Required
Description
-c, --compact
false
Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option.
-h, --help
false
help for list
--limit
int
false
Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100.
--omitCount
false
Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--page
int
false
Page number that specifies a page of results. This value defaults to 1.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
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.
# Return a JSON-formatted list of all database users for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas dbusers list --projectId 5e2211c17a3e5a48f5497de3 --output json
← atlas dbusers describe