atlas users invite
On this page
Create an Atlas user for your MongoDB Atlas application and invite the Atlas user to your organizations and projects.
An Atlas user account grants access only to the the MongoDB Atlas application. To grant database access, create a database user with atlas dbusers create.
Syntax
Command Syntax
atlas users invite [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--country | string | true | ISO 3166-1 alpha two-letter country code of the user's geographic location. The Atlas CLI requires this option. |
--email | string | true | Email address for the user. |
--firstName | string | true | First or given name for the user. |
-h, --help | false | help for invite | |
--lastName | string | true | Last name, family name, or surname for the user. |
--mobile | string | false | Mobile phone number for the user. |
--orgRole | strings | false | Unique 24-digit string that identifies the organization, colon, and the user's role for the organization. Specify this value as orgID:ROLE. Valid values for ROLE include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. |
-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. |
--password | string | false | Password for the user. |
--projectRole | strings | false | Unique 24-digit string that identifies the project, colon, and the user's role for the project. Specify this value as projectID:ROLE. Valid values for ROLE include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. |
--username | string | true | Name that identifies the user. You must specify a valid email address. |
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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
The user '<Username>' has been invited. Invited users do not have access to the project until they accept the invitation.
Examples
# Create the Atlas user with the username user@example.com and invite them to the organization with the ID 5dd56c847a3e5a1f363d424d with ORG_OWNER access: atlas users invite --email user@example.com --username user@example.com --orgRole 5dd56c847a3e5a1f363d424d:ORG_OWNER --firstName Example --lastName User --country US --output json
# Create the Atlas user with the username user@example.com and invite them to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access: atlas users invite --email user@example.com --username user@example.com --projectRole 5f71e5255afec75a3d0f96dc:GROUP_READ_ONLY --firstName Example --lastName User --country US --output json