実験的な : 新規または既存のMongoDB Cloud ユーザー 1 件に対して、組織への参加を招待します。
組織に参加するための招待は指定されたユーザー名に送信され、30 日以内に承認される必要があります。このリソースを使用するには、リクエストするAPIキーに組織所有者のロールが必要です。注: ユーザーが既存のMongoDB Cloud アカウントを持っていない場合、招待を承諾する際にアカウント設定を完了するように求められます。ユーザーがすでにアカウントを持っている場合でも、組織にアクセスするための招待が送信されます。このコマンドは、OpsID: 'createOrganizationUser' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/ MongoDB-Cloud-ユーザー/ 操作/createOrganizationUser
構文
atlas api mongoDbCloudUsers createOrganizationUser [options]
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--file | string | false | APIリクエストの内容を含むファイルへのパス |
-h, --help | false | createOrganizationUser のヘルプ | |
--orgId | string | true | プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列 |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。 |
--pretty | false | レスポンス本体を pretty-print形式にするかどうかを示すフラグ | |
--version | string | false | API 呼び出し [options: "2043-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2043-01-01" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |