Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
MongoDB Ops Manager Administration APIリソース
/
組織とチーム
/
組織

1 つの組織を更新

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例

このエンドポイントを使用して、1 件の組織に対して次のいずれかの変更を行います。

  • 1 件の組織の名前を変更します。

  • 1 つの組織の MongoDB Ops Manager ロールに LDAPグループをマッピングします。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

PATCH /orgs/{ORG-ID}

リクエスト パス パラメーター

名前
タイプ
説明
ORG-ID
string
組織の一意の識別子。

リクエスト クエリ パラメータ

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明
status
HTTPレスポンス コード
content
期待される応答本体
false

リクエスト ボディ パラメータ

リクエスト本文には、次のフィールドの少なくとも 1 つを含める必要があります。

名前
タイプ
必要性
説明
name
string
任意
組織の新しい名前。
ldapGroupMappings
オブジェクト配列
任意
ベースの LDAPMongoDB Ops Managerの場合、 組織ロールへのLDAP グループ のマッピング。MongoDB Ops ManagerLDAP ベースのMongoDB Ops Managerでのみ受け入れられます。

応答

名前
タイプ
説明
id
組織の一意の識別子です。
links
ドキュメント配列
サブリソースや関連リソースへの 1 つ以上のリンク。 URL の関係は、 Web リンク仕様 で説明されています 。
name
string
新しい組織名。
ldapGroupMappings
オブジェクト配列
LDAPベースのMongoDB Ops Managerの場合、 LDAPグループのMongoDB Ops Manager組織ロールへのマッピング。 LDAP ベースのMongoDB Ops Managerにのみ存在します。
ldapGroupMappings
.roleName
string

MongoDB Ops Manager 組織ロール。 可能な値は次のとおりです。

  • ORG_OWNER

  • ORG_MEMBER

  • ORG_GROUP_CREATOR

  • ORG_READ_ONLY

ldapGroupMappings
.ldapGroups
string 配列
MongoDB Ops Manager ロールにマッピングする LDAP プロジェクト。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}?pretty=true" \
 --data '
 {
   "ldapGroupMappings": [{
     "roleName": "ORG_OWNER",
     "ldapGroups": ["org-owner"]
   }]
 },
            "name": "Organization Name 1"
 }'

応答例

1{
2  "id": "{ORG-ID}",
3  "links": [{
4      "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}",
5      "rel": "self"
6    },
7    {
8      "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/groups",
9      "rel": "http://mms.mongodb.com/groups"
10    },
11    {
12      "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/teams",
13      "rel": "http://mms.mongodb.com/teams"
14    },
15    {
16      "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/users",
17      "rel": "http://mms.mongodb.com/users"
18    }
19  ],
20  "name": "Organization Name 1",
21  "ldapGroupMappings": [{
22    "roleName": "ORG_OWNER",
23    "ldapGroups": ["org-owner"]
24  }]
25}

戻る

1 つの組織を作成

次へ

1 つの組織を削除