atlas organizations apiKeys delete
删除组织指定的 API 密钥。
要查看 ID 参数的可能值,请运行 atlas organizations apiKeys list。
要使用此命令,您必须使用具有“组织用户管理员”角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas organizations apiKeys delete <ID> [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
id | 字符串 | true | 唯一的 24 位字符串,用于标识组织的 API 密钥。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--force | false | 指示在继续执行请求的操作之前是否跳过确认提示的标志。 | |
-h,--help | false | 删除帮助 | |
--orgId | 字符串 | false | 要使用的组织 ID。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
API Key '<Name>' deleted
示例
# Remove the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: atlas organizations apiKeys delete 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345