从项目中删除指定的组织 API 密钥。
公共预览版:从MongoDB Atlas Admin API自动生成的 atlas api 子命令提供了对 Admin API的全面覆盖,目前处于公共预览阶段(请通过以下网址提供反馈: https:// 反馈.mongodb.com/ forum/930808 -atlas-cli )。 Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。
API 密钥仍然存在于组织级别。 要将组织 API 密钥重新分配给项目,请运行 atlas projects apiKeys assign 命令。
要查看 ID 参数的可能值,请运行 atlas organizations apiKeys list。
要使用此命令,您必须使用具有项目用户管理员角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas projects apiKeys delete <ID> [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
id | 字符串 | true | 标识 API 密钥的唯一的 24 位字符串。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--force | false | 指示在继续执行请求的操作之前是否跳过确认提示的标志。 | |
-h,--help | false | 删除帮助 | |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
API Key '<Name>' deleted
示例
# Remove an organization API key with the ID 5f46ae53d58b421fe3edc115 from the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys delete 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3