Atlas API mongoDbCloudUser deleteOrganizationUser

: このバージョンのドキュメントはアーカイブされており、サポートされなくなりました。 Atlas CLI のバージョンをアップグレードする方法については、現在のドキュメントを表示してください。

Atlas Admin APIでコマンドを実行中ための Atlas CLI サポートはプレビュー段階です。機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。詳しくは、プレビュー機能を参照してください。

パブリックプレビュー:フィードバックを提供してください : 指定された組織内の 1 人のMongoDB Cloud ユーザーを削除します。

パブリックプレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリックプレビュー段階です（フィードバック 930808-Atlas-cli ）。管理API機能には独自のリリースライフサイクルがあり、提供されているAPIエンドポイントのドキュメントリンクから確認できます。

アクティブなユーザーまたは組織に参加する招待をまだ承諾していないユーザーを削除できます。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーに Organization Owner ロールが必要です。

注: このリソースは、非推奨の「1 人の MongoDB Cloud ユーザーを 1 つのプロジェクトに招待する」エンドポイントとなる接続されたデバイスを介して招待された保留中のユーザーを削除するために使用することはできません。

注意: 保留中のユーザーまたはアクティブなユーザーを削除するには、v2-{2025-02-19} 以降を使用してください。非推奨バージョンを使用している場合、アクティブなユーザーのみが削除されます。

このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/参照/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser.

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

構文

コマンド構文

atlas api mongoDbCloudUsers removeOrganizationUser [options]

オプション

名前	タイプ	必須	説明
-- envelope	envelope	false	アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。
-h, --help		false	deleteOrganizationUser のヘルプ
--orgId	string	true	プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列。 [/orgs](#Tag/Organizations/ 操作/listOrganizations) エンドポイントを使用して、認証されたユーザーがアクセスできるすべての組織を取得します。
-o, --output	string	false	優先API形式は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。
-- outputFile	string	false	API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。
--pretty		false	レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
--userId	string	true	組織内の保留中のユーザーまたはアクティブなユーザーを識別する一意の 24 桁の 16 進数文字列。ユーザーの userId を検索したり、組織内のユーザーのステータスを確認したりする必要がある場合は、[ Return すべてのMongoDB Cloud ユーザーを返す ]（# tags/ MongoDB-Cloud-Users/ 操作/listOrganizationUsers）リソースを使用し、ユーザー名名でフィルタリングします。
--version	string	false	API 呼び出しで使用する API バージョン [options: "2023-01-01", "2025-02-19"] は、デフォルトで最新バージョンまたはプロファイル api_version設定されている場合の構成値この値はデフォルトで "2025-02-19" になります。

継承されたオプション

名前	タイプ	必須	説明
-P, --profile	string	false	構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。

例

atlas api mongoDbCloudUsers removeOrganizationUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId]

戻る

deleteOrganizationRole

deleteProjectRole