Docs Menu
Docs Home
/ /
Atlas App Services
/ / /

appservices users list

On this page

  • Syntax
  • Options
  • Inherited Options

List the application users of your app (alias: ls)

Displays a list of your app's Users' details. The list is grouped by Auth Provider type and sorted by Last Authentication Date.

Command Syntax
appservices users list [options]
Name
Type
Required
Description

-a, --app

string

false

Specify the name or ID of an App Service to list its users

--project

string

false

Specify the ID of a MongoDB Atlas project

-u, --user

strings

false

Filter the App Service's users by ID(s)

--pending

false

View the App Services app's pending users

--state

string

false

Filter the App Services app's users by state (Default value: <none>; Allowed values: enabled, disabled)

--provider

Set

false

Filter the App Services app's users by provider type (Default value: <none>; Allowed values: <none>, "local-userpass", "api-key", "oauth2-facebook", "oauth2-google", "anon-user", "custom-token", "oauth2-apple", "custom-function"). This value defaults to [].

-l, --limit

string

false

Specify the number of users to list. A max of 50 users can be retured in one call.

-h, --help

false

help for list

Name
Type
Required
Description

--profile

string

false

Specify your profile (Default value: "default") [Learn more]

--telemetry

string

false

Enable/Disable CLI usage tracking for your current profile (Default value: "on"; Allowed values: "on", "off")

-o, --output-target

string

false

Write CLI output to the specified filepath

-f, --output-format

string

false

Set the CLI output format (Default value: <blank>; Allowed values: <blank>, "json")

--disable-colors

false

Disable all CLI output styling (e.g. colors, font styles, etc.)

-y, --yes

false

Automatically proceed through CLI commands by agreeing to any required user prompts

Back

enable