mongocli iam globalApiKeys update
修改全局API密钥的角色和描述。
语法
命令语法
mongocli iam globalApiKeys update <ID> [options]
参数
名称 | 类型 | 必需 | 描述 |
|---|---|---|---|
ID | 字符串 | 是 | 一个唯一24位字符串，用于标识全局API密钥。 |
选项
名称 | 类型 | 必需 | 描述 |
|---|---|---|---|
--desc | 字符串 | 是 | API密钥的描述。 |
-h, --help | 否 | 更新帮助信息 | |
-o, --output | 字符串 | 否 | 输出格式。有效值有json, json-path, go-template, 或 go-template-file。要查看完整输出，请使用-o json选项。 |
--role | 字符串 | 是 | 要将API密钥分配到的角色或角色列表。要分配多个角色，可以使用单独的角色标志指定每个角色，或使用一个角色标志以逗号分隔列表指定所有角色。有效值有GLOBAL_AUTOMATION_ADMIN, GLOBAL_BACKUP_ADMIN, GLOBAL_MONITORING_ADMIN, GLOBAL_OWNER, GLOBAL_READ_ONLY, GLOBAL_USER_ADMIN。传递此标志将替换现有数据。 |
继承选项
名称 | 类型 | 必需 | 描述 |
|---|---|---|---|
-P, --profile | 字符串 | 否 | 配置文件中使用的配置文件名称。了解MongoCLI的配置文件，请参阅https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
示例
# Modify the roles and description for the global API key with the ID 5f5bad7a57aef32b04ed0210: mongocli iam globalApiKeys update 5f5bad7a57aef32b04ed0210 --desc "My Sample Global API Key" --role GLOBAL_MONITORING_ADMIN --output json