パブリック プレビュー: にフィードバックを提供してください: 指定された組織内の 1 人のMongoDB Cloud ユーザーを更新します。
アクティブなユーザーまたは招待をまだ承諾していないユーザーを更新して、組織への参加を更新できます。このリソースを使用するには、リクエストするAPIキーに組織所有者のロールが必要です。
注:リクエスト本文には更新するフィールドのみを含めます。空の値を持つフィールドを指定すると、ユーザーのそのフィールドがリセットされます。
注: このリソースは、非推奨の 「1 人のMongoDB Cloud ユーザーを 1 つのプロジェクトに招待」 エンドポイントによって招待された保留中のユーザーを更新するために使用することはできません。
1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/ MongoDB- Cloud-Users/ 操作/updateOrganizationUser。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api mongoDbCloudUsers updateOrganizationUser [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--file | string | false | APIリクエストファイルへのパス。代わりに標準入力を使用するには、 を空のままにします。どちらか一方を指定する必要がありますが、両方を指定することはできません。 |
-h, --help | false | updateOrganizationUser のヘルプ | |
--orgId | string | true | プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列。 [/orgs](#Tag/Organizations/ 操作/listOrganizations) エンドポイントを使用して、認証されたユーザーがアクセスできるすべての組織を取得します。 |
--出力 | 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 ユーザーを返す」リソースを使用し、ユーザー名でフィルターします。 |
--version | string | false | API 呼び出し [options: "2025-02-19"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2025-02-19" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |