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

mongocli iam projects apiKeys delete

本页内容

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

从您的项目中删除指定的组织API密钥。

该API密钥在组织级别仍然存在。要将组织API密钥重新分配给项目,请运行mongocli iam projects apiKeys assign命令。

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

要使用此命令,您必须使用具有项目用户管理员角色的用户帐户或API密钥进行认证。

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

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

API Key '<Name>' deleted
# Remove an organization API key with the ID 5f46ae53d58b421fe3edc115 from the project with ID 5e2211c17a3e5a48f5497de3:
mongocli iam projects apiKeys delete 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3

返回

创建