文档菜单
文档首页
/ /
MongoDB CLI
/ / / /

mongocli iam organizations apiKeys delete

本页内容

  • 语法
  • 参数
  • 选项
  • 继承选项
  • 输出
  • 示例

删除组织指定的API密钥。

要查看ID参数的可能值,请运行mongocli iam organizations apiKeys list。

使用此命令,您必须使用具有组织用户管理员角色的用户账户或API密钥进行身份验证。

命令语法
mongocli iam organizations apiKeys delete <ID> [options]
名称
类型
必需
描述
ID
字符串
唯一24位字符串,用于标识组织的API密钥。
名称
类型
必需
描述
--force
false
表示在执行请求的操作之前是否跳过确认提示的标志。
-h, --help
false
删除的帮助信息
--orgId
字符串
false
要使用的组织ID。此选项覆盖配置文件或环境变量中的设置。
名称
类型
必需
描述
-P, --profile
字符串
false
从您的配置文件中使用的配置文件名。有关MongoCLI配置文件的配置信息,请参阅https://dochub.mongodb.org/core/atlas-cli-configuration-file.

如果命令成功执行,CLI将返回类似于以下示例的输出。括号内的值代表您的值。

API Key '<Name>' deleted
# Remove the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345:
mongocli iam organizations apiKeys delete 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345

返回

创建