mongocli IAM 組織 apiKeys delete
組織に対して指定された API キーを削除します。
ID 引数の可能な値を表示するには、 mongocli IAM 組織 apiKeys list を実行します。
このコマンドを使用するには、ユーザー アカウントまたは組織ユーザー管理者ロールの API キーで認証する必要があります。
構文
コマンド構文
mongocli iam organizations apiKeys delete <ID> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
ID | string | true | string組織のAPI キーを識別する一意な 24 桁の 。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- force | false | 要求されたアクションを続行する前に確認プロンプトをスキップするかどうかを示すフラグ。 | |
-h, --help | false | 削除のヘルプ | |
--orgId | string | false | 使用する組織ID。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 MongoCLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-configuration-file を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
API Key '<Name>' deleted
例
# Remove the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: mongocli iam organizations apiKeys delete 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345