realm-cli users delete
On this page
Atlas Device Sync, Atlas Edge Server, Data API, and HTTPS Endpoints are deprecated. Refer to the deprecation page for details.
Important
Realm CLI is Deprecated
realm-cli is deprecated and will not receive future features or
bug fixes. Instead, use the App Services CLI.
App Services CLI is available on npm. To install the CLI on your system,
ensure that you have Node.js
installed and then run the following command in your shell:
npm install -g atlas-app-services-cli
Delete an application user from your App
You can remove multiple users at once with the "--user" flag. You can only specify these users using their ID values.
Syntax
realm-cli users delete [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-a, --app | string | false | Specify the name or ID of an App to delete its users |
-u, --user | strings | false | Specify the App's users' ID(s) to delete |
--pending | false | View the App's pending users | |
--state | String | false | Filter the App's users by state (Default value: <none>; Allowed values: enabled, disabled) |
--provider | Set | false | Filter the 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") (default []) |
-h, --help | false | help for delete |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
--profile | string | false | Specify your profile (Default value: "default") (default "default") |
--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 |