パブリック プレビュー:フィードバックを提供してください : 指定されたチームから 1 人のMongoDB Cloud ユーザーを削除します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です（フィードバック 930808-Atlas-cli ）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
このチームは 1 つの組織に属しています。チームを使用すると、MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーに Organization Owner ロールが必要です。
注: このエンドポイントとなる接続されたデバイスは非推奨です。アクティブなユーザーまたは保留中のユーザーをチームから削除するには、「1 つのチームから 1 人の MongoDB Cloud ユーザーを削除」を使用します。
このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-removeteamuser.
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api teams removeTeamUser [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
-h, --help | false | deleteTeamUser のヘルプ | |
--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 形式にするかどうかを示すフラグ。 | |
--teamId | string | true | 1 件のデータベース アプリケーション ユーザーを削除するチームを識別する、ユニークな 24 桁の 16 進数の文字列。 |
--userId | string | true | 指定したチームから削除する MongoDB Cloud ユーザーを識別する、ユニークな 24 桁の 16 進数の文字列。 |
--version | string | false | API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
例
atlas api teams removeTeamUser --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] --userId [userId]