atlas api organizations createOrg

MongoDB Cloud に組織を 1 件作成し、それをリクエスト元のサービスアカウントまたは API キーの組織にリンクさせます。

atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリースライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメントリンクから確認できます。

リクエスト元のサービスアカウントまたは API キーの組織は、支払い組織である必要があります。詳細については、MongoDB Atlas ドキュメントの「支払い組織の構成」を参照してください。オプションとして、federationSettingsId が提供される場合、新しい組織はフェデレーションにリンクされます。リクエストするサービスアカウントまたは API キーは、フェデレーションの Organization Owner である必要があります。

このコマンドは自動生成されており、1:1 は Atlas API のエンドポイントとなる接続されたデバイス https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-createorg. に対応しています。

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

構文

コマンド構文

atlas api organizations createOrg [options]

オプション

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

継承されたオプション

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