mongocli IAM globalApiKeys update

グローバル API キーのロールと説明を変更します。

構文

コマンド構文

mongocli iam globalApiKeys update <ID> [options]

Arguments

名前	タイプ	必須	説明
ID	string	true	グローバルstring キーを識別する一意な 24API 桁の。

オプション

名前	タイプ	必須	説明
--desc	string	true	API キーの説明。
-h, --help		false	更新のヘルプ
-o, --output	string	false	出力形式。有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。完全な出力を表示するには、 -o JSONオプションを使用します。
--role	string	true	API キーに割り当てたいロール。複数のロールを割り当てるには、個別のロールフラグで各ロールを指定するか、1 つのロールフラグを使用してすべてのロールをカンマ区切りのリストとして指定します。有効な値は、GLOBAL_AutoMation_ADMIN、GLOBAL_BACKUP_ADMIN GLOBAL_MONITORING_ADMIN、GLOBAL_OWNER、GLOBAL_READ_ONLY、GLOBAL_USER_ADMIN このフラグを渡すと、既存のデータが置き換えられます。

継承されたオプション

名前	タイプ	必須	説明
-P, --profile	string	false	構成ファイルから使用するプロファイルの名前。MongoCLI のプロファイルについては、 https://docub.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

戻る

list

組織