実験的な : 指定されたユーザーの一意な識別子を持つ 1 つのMongoDB Cloud ユーザー アカウントの詳細を返します。
このエンドポイントを使用してAPIキーに関する情報を返すことはできません。APIキーに関する情報を返すには、 1 つの組織を返すAPIキー エンドポイントを使用します。自分のユーザー アカウントはいつでも検索できます。MongoDB Cloud組織またはプロジェクトのオーナーであれば、その組織またはプロジェクトのメンバーシップを持つ全ユーザーのユーザー プロファイルも検索できます。このリソースは、リクエスト元のAPIキーがどのようなロールを持っていても使用できます。このコマンドは、OperationID: 'getUser' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/ MongoDB-Cloud-ユーザー/ 操作/getUser
構文
atlas api mongoDbCloudUsers getUser [options]
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
-h, --help | false | getUser のヘルプ | |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。 |
--pretty | false | レスポンス本体を pretty-print形式にするかどうかを示すフラグ | |
--userId | string | true | このユーザーを識別する一意な 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 を参照してください。 |