このエンドポイントを使用して、1 件の組織に対して次のいずれかの変更を行います。
1 件の組織の名前を変更します。
LDAPグループを 1 つの組織の MongoDB Ops Manager ロールにマッピングします。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /orgs/{ORG-ID}リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | 組織の一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
リクエスト本文には、次のフィールドの少なくとも 1 つを含める必要があります。
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
name | string | 任意 | 組織の新しい名前。 |
ldapGroupMappings | オブジェクト配列 | 任意 | LDAPベースのMongoDB Ops Managerの場合、 LDAPグループのMongoDB Ops Manager組織ロールへのマッピング。 LDAP ベースのMongoDB Ops Managerでのみ受け入れられます。 |
応答
名前 | タイプ | 説明 |
|---|---|---|
| 組織の一意の識別子です。 | |
| ドキュメント配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 Web リンク仕様 は、URL 間の関係について説明します。 |
| string | 新しい組織名。 |
| オブジェクト配列 | LDAPベースのMongoDB Ops Managerの場合、 LDAPグループのMongoDB Ops Manager組織ロールへのマッピング。 LDAP ベースのMongoDB Ops Managerにのみ存在します。 |
| string | MongoDB Ops Manager 組織ロール。 可能な値は次のとおりです。
|
| 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" }'応答例
{ "id": "{ORG-ID}", "links": [{ "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}", "rel": "self" }, { "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/groups", "rel": "http://mms.mongodb.com/groups" }, { "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/teams", "rel": "http://mms.mongodb.com/teams" }, { "href": "http://{opsManagerHost}:{port}/api/public/v1.0/orgs/{ORG-ID}/users", "rel": "http://mms.mongodb.com/users" } ], "name": "Organization Name 1", "ldapGroupMappings": [{ "roleName": "ORG_OWNER", "ldapGroups": ["org-owner"] }]}