atlas organizations invitations invite

Invite the specified MongoDB user to your organization.

To use this command, you must authenticate with a user account, a service account, or an API key with the Organization User Admin role.

Syntax

Command Syntax

atlas 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
-f, --file	string	false	Path to an optional JSON configuration file that defines invitation settings. Note: Unsupported fields in the JSON file are ignored. Mutually exclusive with --role, --teamId.
-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	false	User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. Mutually exclusive with --file.
--teamId	strings	false	Unique 24-digit string that identifies the team. Mutually exclusive with --file.

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.

User '<Username>' invited.

Examples

# Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access:
atlas organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json

Back

describe

list