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