atlas organizations apiKeys assign
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.
Update an Organization API Key.
Syntax
atlas organizations apiKeys assign <apiKeyId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
apiKeyId | string | true | API key identifier. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--desc | string | false | Description of the API key. |
-h, --help | false | help for assign | |
--orgId | string | false | Organization ID to use. 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. |
--role | strings | false | List of roles for the API key. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |