Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas teams create

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Create a team for your organization.

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

Command Syntax
atlas teams create <name> [options]
Name
Type
Required
Description
name
string
true
Label that identifies the team.
Name
Type
Required
Description
-h, --help
false
help for create
--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.
--username
strings
true
Comma-separated list that contains the valid usernames of the MongoDB users to add to the new team. A team must have at least one user. New users must accept the invitation to join an organization before you can add them to a team.
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.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

Team '<Name>' created.
# Create a team named myTeam in the organization with ID 5e2211c17a3e5a48f5497de3:
atlas teams create myTeam --username user1@example.com,user2@example.com --orgId 5e1234c17a3e5a48f5497de3 --output json

Back

teams