パブリック プレビュー: にフィードバックを提供してください: 指定されたプロジェクトから 1 人のMongoDB Cloud ユーザーを削除します。
アクティブなユーザーまたは組織に参加する招待をまだ承諾していないユーザーを削除できます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナー ロールが必要です。
注: このリソースは、非推奨の「1 人の MongoDB Cloud ユーザーを 1 つのプロジェクトに招待する」エンドポイントとなる接続されたデバイスを介して招待された保留中のユーザーを削除するために使用することはできません。
注意: 保留中のユーザーまたはアクティブなユーザーを削除するには、v2-{2025-02-19} 以降を使用してください。非推奨バージョンを使用している場合、アクティブなユーザーのみが削除されます。
このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/参照/api-resources-spec/v2/#tags/MongoDB-Cloud-Users/操作/removeProjectUser.
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api mongoDbCloudUsers removeProjectUser [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | delete ProjectUser のヘルプ | |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。 |
--pretty | false | ||
--userId | string | true | プロジェクト内の保留中のユーザーまたはアクティブなユーザーを識別する一意の 24 桁の 16 進数文字列。 ユーザーの userId を検索したり、組織内のユーザーのステータスを確認したりする必要がある場合は、[ 1 つのプロジェクトのすべてのMongoDB Cloud ユーザーを返す ](# tags/ MongoDB-Cloud-Users/ 操作/listProjectUsers)リソースを使用し、ユーザー名名 でフィルタリングします。 |
--version | string | false | API 呼び出しで使用する API バージョン [options: "2023-01-01", "2025-02-19"] は、デフォルトで最新バージョンまたはプロファイル api_version設定されている場合の構成値この値はデフォルトで "2025-02-19" になります。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
例
以下の コマンドを実行します。
atlas api mongoDbCloudUsers removeProjectUser --version 2025-02-19 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --userId [userId]