realm-cli users create
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
Create an application user for your App
Adds a new user to your App. You can create a user for the following enabled authentication providers: "Email/Password" or "API Key".
Syntax
realm-cli users create [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-a, --app | string | false | Specify the name or ID of an App to create its users |
--type | String | false | Select the type of user to create (Default value: <none>; Allowed values: api-key, email) |
--name | string | false | Specify the name of the new API Key |
--email | string | false | Specify the email of the new user |
--password | string | false | Specify the password of the new user |
-h, --help | false | help for create |
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 |