パブリックプレビュー: にフィードバックを提供してください: 指定された組織のコンテキスト内で、指定されたMongoDB Cloud ユーザーに関する情報を返します。
このリソースを使用するには、リクエスト元の API キーに組織メンバーロールが必要です。
注:このリソースは、MongoDB Cloud の人間ユーザーに関する情報を取得するためにのみ使用できます。APIキーに関する情報を返すには、 1 つの組織を返す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/操作/getOrganizationUser。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api mongoDbCloudUsers getOrganizationUser [options]
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
-h, --help | false | getOrganizationUser のヘルプ | |
--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 を参照してください。 |
例
以下の コマンドを実行します。
atlas api mongoDbCloudUsers getOrganizationUser --version 2025-02-19 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --userId [userId]