mongocli iam organizations apiKeys delete
On this page
This version of the documentation is archived and no longer supported. View the current documentation to learn how to update your version of the MongoDB CLI.
Remove the specified API key for your organization.
To view possible values for the ID argument, run mongocli organizations apiKeys list.
To use this command, you must authenticate with a user account or an API key that has the Organization User Admin role.
Syntax
mongocli iam organizations apiKeys delete <ID> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
ID | string | true | Unique 24-digit string that identifies the organization's API key. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--force | false | Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. | |
-h, --help | false | help for delete | |
--orgId | string | false | Organization ID to use. Overrides the settings in the configuration file or environment variable. |
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. |
Examples
# Remove the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: mongocli organizations apiKeys delete 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345