1 つの組織を作成
項目一覧
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
必須のロール
このリソースを正常に呼び出すには、API キーに Global Ownerロールが必要です。
注意
グローバル プログラム API キーを使用して組織を作成する場合、MongoDB Ops Manager はOrganization Ownerなしで組織を作成します。 Organization Ownerを追加するには、「 MongoDB Ops Managerアクセス 」を参照してください。
リクエスト
POST /orgs
Request Parameters
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを falseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。 | true |
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
ldapGroupMappings | 配列 | 任意 | LDAPMongoDB Ops Managerの 統合が必要です。 MongoDB Ops Manager組織ロールとLDAP グループ間のマッピングを指定するドキュメントの配列。
|
ldapGroupMappings.roleName | string | 任意 | マッピングする MongoDB Ops Manager 組織ロール。 次のリストから指定できます。
グローバル ロール、プロジェクト ロール、または組織請求管理者ロールを指定することはできません。 |
ldapGroupMappings.ldapGroups | 配列 | 任意 | roleNameに関連付けるようにマッピングするLDAPグループ。 |
name | string | 必須 | 作成する組織の名前。 |
応答パラメータ
名前 | タイプ | 説明 |
|---|---|---|
id | string | 組織の一意の識別子です。 |
name | string | 組織名。 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST "https://{opsManagerHost}:{port}/api/public/v1.0/orgs" \ --data '{ "name" : "myNewOrganization" }'
応答例
応答ヘッダー
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
レスポンス本体
{ "id" : "{ORG-ID}", "name" : "myNewOrganization" }