修改全局 API 密钥的角色和描述。
语法
命令语法
mongocli iam globalApiKeys update <ID> [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
id | 字符串 | true | 标识全局 API 密钥的 24 位唯一字符串。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--desc | 字符串 | true | API 密钥的描述。 |
-h，--help | false | 更新帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
--role | 字符串 | true | 要分配给 API 密钥的一个或多个角色。 要分配多个角色，可以使用单独的角色标志指定每个角色，或者使用一个角色标志将所有角色指定为以逗号分隔的列表。 有效值为 GLOBAL_AUTOMATION_ADMIN、GLOBAL_BACKUP_ADMIN、GLOBAL_MONITORING_ADMIN、GLOBAL_OWNER、GLOBAL_READ_ONLY、GLOBAL_USER_ADMIN。 传递此标志会替换先前存在的数据。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解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