atlas api mongoDbCloudUsers getUserByUsername

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

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

パブリックプレビュー:フィードバックを提供してください : 指定されたユーザー名を持つ 1 つのMongoDB Cloud ユーザーアカウントの詳細を返します。

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

このエンドポイントを使用して API キーに関する情報を返すことはできません。API キーに関する情報を返すには、1 つの組織を返す API キーエンドポイントを使用します。このリソースは、リクエスト元のサービスアカウントまたは API キーがどのようなロールを持っていても使用できます。

このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-getuserbyusername 。

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

構文

コマンド構文

atlas api mongoDbCloudUsers getUserByUsername [options]

オプション

名前	タイプ	必須	説明
-- envelope	envelope	false	アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。
-h, --help		false	getUserByUsername のヘルプ
-o, --output	string	false	優先API形式は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。
-- outputFile	string	false	API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。
--pretty		false	レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
--username	string	true	MongoDB Cloud ユーザーアカウントのメールアドレス。ユーザーを作成した後に、このアドレスを変更することはできません。
--version	string	false	API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値をプロファイルします。この値のデフォルトは "2023-01-01"

継承されたオプション

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

戻る

getUser

listOrganizationUsers