- This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.
Create an organization.
When authenticating using API keys, the organization to which the API keys belong must have cross-organization billing enabled. The resulting org will be linked to the paying org.
Syntax
atlas organizations create <name> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
name | string | true | Label that identifies the organization. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--apiKeyDescription | string | false | Description of the API key.Required when creating organizations authenticated with API Keys. |
--apiKeyRole | strings | false | Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey.Required when creating organizations authenticated with API Keys. |
--federationSettingsId | string | false | Unique 24-hexadecimal digit string that identifies the federation settings. |
-h, --help | false | help for create | |
-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. |
--ownerId | string | false | Unique 24-digit string that identifies the Atlas user to be granted the Org Owner role on the specified organization. Required if using API keys. |
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. |
Examples
# Create an Atlas organization with the name myOrg: atlas organizations create myOrg --output json