mongocli iam organizations invitations invite
On this page
Invite the specified MongoDB user to your organization.
To use this command, you must authenticate with a user account or an API key with the Organization User Admin role.
Syntax
Command Syntax
mongocli iam organizations invitations invite <email> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
email | string | true | Email address that belongs to the user that you want to invite to the organization. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for invite | |
--orgId | string | false | Organization ID to use. This option overrides the settings in the configuration file or environment variable. |
-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. |
--role | strings | true | User's roles for the associated organization. To learn which values MCLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/createOrganizationInvitation/. |
--teamId | strings | false | Unique 24-digit string that identifies the team. |
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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Examples
# Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access: mongocli iam organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json